VastbaseG100

基于openGauss内核开发的企业级关系型数据库。

Menu

PQescapeStringConn

功能描述

转义字符串常量。

接口原型

size_t PQescapeStringConn(PGconn *conn,
                          char *to, const char *from, size_t length,
                          int *error);

参数说明

参数名 参数说明
conn 建立连接时返回的连接结构体指针,该指针用于标识某个特定连接。
to 函数将转义结果字符串写到to指针指向的内存。to应该指向一个包含至少多于两倍 length大小的缓冲区,要么就不会定义该行为。如果to和from 字符串交叠,那么也不会定义该行为。
from from 参数指向用以转义的输入字符串的第一个字符。
length from字符串长度。若在达到此长度之前,str串中出现了’\0’,则在’\0’处结束;否则以length长度结束,此行为类似于strncpy。
error 当error参数非NULL时,在成功的时候*error会被置为零, 失败时置非0。

返回值

PQescapeStringConn返回写到to的字节数,’\0’字符不计入。

其他

PQescapeStringConn转义字符串常量,比较像PQescapeLiteral。 不同于PQescapeLiteral,请求应该提供一个适当大小的缓冲区。更重要的是, PQescapeStringConn不会生成一个必须在PostgreSQL 字符串常量两端的单引号;SQL命令中应该提供,这样结果中会被插入。error参数非NULL,那么在成功的时候*error会被设置为零, 失败的时候设置为非0。目前唯一可能的错误条件涉及在源字符串中无效的多字节编码。 输出字符串同样产生错误,但服务器可以视其为异常以拒绝。一旦发生错误, 一条合适的信息会存储在conn对象中,无论error是否为NULL。