#C驱动接口列表

接口名称 接口函数声明 接口说明 参数说明
yacGetDiagRec YacResult yacGetDiagRec(YacInt32* errCode, YacChar* message, YacInt32 bufLen, YacInt32* incicator, YacChar* sqlState, YacInt32 sqlStateBufLen, YacTextPos* pos); 当函数调用返回YAC_ERROR或者YAC_SUCCESS_WITHINFO后获取诊断信息 [1] errCode:YashanDB错误码序号。
[2] message:错误码信息buf地址。
[3] bufLen:错误码信息buf大小。
[4] incicator:错误码信息buf实际填充大小指针。
[5] sqlState:SQL标准错误码buf地址。
[6] sqlStateBufLen:SQL标准错误码buf大小。
[7] pos:错误出现的行列位置。
[8] 返回结果:空。
yacAllocHandle yacResult yacAllocHandle(yacHandleType type, yacHandle input, yacHandle* output); 为句柄分配空间 [1] type:句柄类型。
[2] input:输入句柄。
[3] output:输出句柄,该句柄挂在输入句柄上。
[4] 返回结果:YAC_SUCCESS为分配成功,YAC_ERROR为分配失败。
yacFreeHandle yacResult yacFreeHandle(yacHandleType type, yacHandle handle); 释放句柄空间 [1] type:句柄类型。
[2] handle:句柄。
[3] 返回结果:YAC_SUCCESS为释放成功,YAC_ERROR为释放失败。
yacConnect yacResult yacConnect(yacHandle hConn, const yacChar* url, YacInt16 urlLength, const yacChar* user, YacInt16 userLength, const yacChar* password, YacInt16 passwordLength); 客户端发起连接请求 [1] hConn:连接信息句柄。
[2] url:服务端的地址。
[3] urlLength:服务端地址长度。
[4] user:用户名。
[5] userLength:用户名长度。
[6] password:用户密码。
[7] passwordLength:用户密码长度。
[8] 返回结果:YAC_SUCCESS为连接成功,YAC_ERROR为连接失败。
yacDisconnect YacVoid yacDisconnect(yacHandle hConn); 客户端发起断开连接请求 [1] hConn:连接信息句柄。
[2] 返回结果:空。
yacCancel YacResult yacCancel(YacHandle hConn); 客户端发起取消当前会话请求 [1] hConn:连接信息句柄。
[2] 返回结果:YAC_SUCCESS为取消成功,YAC_ERROR为取消失败。
yacDirectExecute yacResult yacDirectExecute(yacHandle hStmt, const yacChar* sql, YacInt32 sqlLength); 客户端发起执行不需绑定数据或绑定参数数据的sql的请求 [1] hStmt:SQL信息句柄。
[2] sql:SQL语句字符串。
[3] sqlLength:SQL语句长度。
[4] 返回结果:YAC_SUCCESS为执行成功,YAC_ERROR为执行失败。
yacPrepare yacResult yacPrepare(yacHandle hStmt, const yacChar* sql, YacInt32 sqlLength); 客户端发起预编译sql的请求 [1] hStmt:SQL信息句柄。
[2] sql:SQL语句字符串。
[3] sqlLength:SQL语句长度。
[4] 返回结果:YAC_SUCCESS为预编译成功,YAC_ERROR为预编译失败。
yacExecute yacResult yacExecute(yacHandle hStmt); 客户发起执行yacPrepare预编译的sql的请求 [1] hStmt:SQL信息句柄。
[2] 返回结果:YAC_SUCCESS为执行成功,YAC_ERROR为执行失败。
yacFetch yacResult yacFetch(yacHandle hStmt, yacUint32* rows); 客户端发起获取结果集的请求 [1] hStmt:SQL信息句柄。
[2] rows:指针,值是获取记录的行数。
[3] 返回结果:YAC_SUCCESS为获取成功,YAC_ERROR为获取失败。
yacCommit yacResult yacCommit(yacHandle hConn); 客户端发起提交请求 [1] hConn:连接信息句柄。
[2] 返回结果:YAC_SUCCESS为提交成功,YAC_ERROR为提交失败。
yacRollback yacResult yacRollback(yacHandle hConn); 客户端发起回滚请求 [1] hConn:连接信息句柄。
[2] 返回结果:YAC_SUCCESS为回滚成功,YAC_ERROR为回滚失败。
yacSetEnvAttr YacResult yacSetEnvAttr(YacHandle hEnv, YacEnvAttr attr, YacVoid* value, YacInt32 length); 设置环境信息句柄中的某个属性值 [1] hEnv:环境句柄。
[2] attr:属性类型。
[3] value:入参,欲设置的属性值。
[4] len:欲设置的属性值的缓冲区长度。
[5] 返回结果:YAC_SUCCESS为设置成功,YAC_ERROR为设置失败。
yacGetEnvAttr YacResult yacGetEnvAttr(YacHandle hEnv, YacEnvAttr attr, YacVoid* value, YacInt32 bufLength, YacInt32* stringLength); 获取环境句柄中的某个属性值 [1] hEnv:环境句柄。
[2] attr:属性类型。
[3] value:出参,存储获取到的属性值。
[4] bufLength:获取到的属性值的缓冲区长度。
[5] stringLength:获取到的属性值的实际长度。
[6] 返回结果:YAC_SUCCESS为获取成功,YAC_ERROR为获取失败。
yacSetConnAttr yacResult yacSetConnAttr(yacHandle hConn, yacConnAttr attr, YacVoid* value, YacInt32 bufLength); 设置连接信息句柄中的某个属性值 [1] hConn:连接信息句柄。
[2] attr:属性类型。
[3] value:入参,欲设置的属性值。
[4] len:欲设置的属性值的缓冲区长度。
[5] 返回结果:YAC_SUCCESS为设置成功,YAC_ERROR为设置失败。
yacGetConnAttr yacResult yacGetConnAttr(yacHandle hConn, yacConnAttr attr, YacVoid* value, YacInt32 bufLength, YacInt32* stringLength); 获取连接信息句柄中的某个属性值 [1] hConn: 连接信息句柄。
[2] attr:属性类型。
[3] value:出参,存储获取到的属性值。
[4] bufLen:获取到的属性值的存储区长度。
[5] 返回结果:YAC_SUCCESS为获取成功,YAC_ERROR为获取失败。
yacSetStmtAttr yacResult yacSetStmtAttr(yacHandle hStmt, yacStmtAttr attr, YacVoid* value, YacInt32 bufLength); 设置sql信息句柄中的某个属性值 [1] hStmt: sql信息句柄。
[2] attr:属性类型。
[3] value:入参,欲设置的属性值。
[4] len:欲设置的属性值的存储区长度。
[5] 返回结果:YAC_SUCCESS为设置成功,YAC_ERROR为设置失败。
yacGetStmtAttr yacResult yacGetStmtAttr(yacHandle hStmt, yacStmtAttr attr, YacVoid* value,YacInt32 bufLength, YacInt32* stringLength); 获取sql信息句柄中的某个属性值 [1] hStmt: sql信息句柄。
[2] attr:属性类型。
[3] value:出参,存储获取到的属性值。
[4] bufLen:获取到的属性值的存储区长度。
[5] 返回结果:YAC_SUCCESS为获取成功,YAC_ERROR为获取失败。
yacBindColumn yacResult yacBindColumn(yacHandle hStmt, yacUint16 id, yacType type, yacPointer value, yacInt32 bufLen, yacInt32* indicator); 客户端对指定列的属性绑定赋值 [1] hStmt:SQL信息句柄。
[2] id:入参,列的编号索引(0表示第1列)。
[3] type:入参,要绑定到id列的类型。
[4] value:入参,要绑定到id列的值。
[5] bufLen:入参,要绑定到id列的列宽。
[6] indicator:出入参,辅助指针,作为入参,其值是绑定到id列的变长类型值的长度。此时对于非变长类型(包括使用lobLocator绑定的类型),其值不生效。作为出参,其值表示结果集取值情况。该指针可赋为为NULL,表示不生效。
[7] 返回结果:YAC_SUCCESS为绑定成功,YAC_ERROR为绑定失败。
yacBindParameter YacResult yacBindParameter(YacHandle hStmt, YacUint16 id, YacParamDirection direction, YacType bindType, YacPointer value, YacInt32 bindSize, YacInt32 bufLength, YacInt32* indicator); 客户端对指定参数的属性绑定赋值 [1] hStmt: 记录与SQL相关的多种信息的句柄。
[2] id:入参,参数的编号索引(1表示第1个参数)。预编译SQL中如果使用:name形式占位符且多处同名,按位置绑定值时需要绑定多次。通常同名占位符位置绑定的是相同值。
[3] direction:入参,参数类型,1为入参,2为出参,3为出入参。
[4] bindType:入参,要绑定到该参数的类型。
[5] value:入参,要绑定到该参数的值。
[6] bindSize:入参,要绑定到该参数的限制长度。
[7] bufLength:入参,要绑定到该参数的值所在缓冲区长度。
[8] indicator:出入参,辅助指针,作为入参,其值是绑定到id列的变长类型值的长度。此时对于非变长类型(包括使用lobLocator绑定的类型),其值不生效。作为出参,其值表示绑定参数取值情况。该指针可赋为为NULL,表示不生效。
[9] 返回结果:YAC_SUCCESS为绑定成功,YAC_ERROR为绑定失败。
yacBindParameterByName YacResult yacBindParameterByName(YacHandle hStmt, YacChar* name, YacParamDirection direction, YacType bindType, YacPointer value, YacInt32 bindSize, YacInt32 bufLength, YacInt32* indicator); 客户端按参数名对指定参数的属性绑定赋值 [1] hStmt: 记录与SQL相关的多种信息的句柄。
[2] name:入参,参数名。
[3] direction:入参,参数类型,1为入参,2为出参,3为出入参。
[4] bindType:入参,要绑定到该参数的类型。
[5] value:入参,要绑定到该参数的值。
[6] bindSize:入参,要绑定到该参数的限制长度。
[7] bufLength:入参,要绑定到该参数的值所在缓冲区长度。
[8] indicator:出入参,辅助指针,作为入参,其值是绑定到id列的变长类型值的长度。此时对于非变长类型(包括使用lobLocator绑定的类型),其值不生效。作为出参,其值表示绑定参数取值情况。该指针可赋为为NULL,表示不生效。
[9] 返回结果:YAC_SUCCESS为绑定成功,YAC_ERROR为绑定失败。
yacColAttribute YacResult yacColAttribute(YacHandle hStmt, YacUint16 id, YacColAttr attr, YacVoid* value, YacInt32 bufLen, YacInt32* stringLength); 获取sql信息句柄中的某个列属性值 [1] hStmt: sql信息句柄。
[2] id:入参,列的编号索引(0表示第1列)。
[3] attr:属性类型。
[4] value:出参,存储获取到的属性值。
[5] bufLen:获取到的属性值的存储区长度。
[6] 返回结果:YAC_SUCCESS为获取成功,YAC_ERROR为获取失败。
yacNumResultCols yacResult yacNumResultCols(yacHandle hStmt, yacInt16* count); 获取结果集中列的数量 [1] hStmt: sql信息句柄。
[2] count:出参,存储获取到的列数量。
[3] 返回结果:YAC_SUCCESS为获取成功,YAC_ERROR为获取失败。
yacNumParams YacResult yacNumParams(YacHandle hStmt, YacUint16* count); 获取语句中参数的数量 [1] hStmt: sql信息句柄。
[2] count:出参,存储语句中参数的数量。
[3] 返回结果:YAC_SUCCESS为获取成功,YAC_ERROR为获取失败。
yacStmtGetNextResult YacResult yacStmtGetNextResult(YacHandle hStmt, YacHandle* cursor, YacUint32* rtType); 获取隐式结果集 [1] hStmt: sql信息句柄。
[2] cursor:出参,服务端通过dbms_sql.return_result返回给客户端的游标。
[3] rtType:出参,隐式结果集类型,固定值YAC_RESULT_TYPE_SELECT。
[4] 返回结果:YAC_SUCCESS为获取成功,YAC_ERROR为获取失败。
yacLobDescAlloc yacResult yacLobDescAlloc(yacHandle hConn, yacType type, YacVoid** desc); LOB协议中,为loblocator分配空间 [1] hConn:记录与连接相关的多种信息的句柄。
[2] type:入参,LOB类型。
[3] desc:出参,指向被分配空间的loblocator。
[4] 返回结果:YAC_SUCCESS为分配空间成功,YAC_ERROR为分配空间失败。
yacLobDescFree yacResult yacLobDescFree(YacVoid* desc, yacType type); LOB协议中,为loblocator释放空间 [1] desc:入参,指向loblocator。
[2] type:入参,LOB类型。
[3] 返回结果:YAC_SUCCESS为释放空间成功,YAC_ERROR为释放空间失败。
yacLobGetChunkSize yacResult yacLobGetChunkSize(yacHandle hConn, yacLobLocator* locator, yacUint16* chunkSize); LOB协议中,获取LOB的chunkSize [1] hConn:记录与连接相关的多种信息的句柄。
[2] locator:入参,LOB协议中的loblocator。
[3] chunkSize:出参,存储获取到的chunkSize。
[4] 返回结果:YAC_SUCCESS为获取成功,YAC_ERROR为获取失败。
yacLobGetLength yacResult yacLobGetLength(yacHandle hConn, yacLobLocator* locator, yacUint64* length); LOB协议中,获取LOB数据总长度 [1] hConn:记录与连接相关的多种信息的句柄。
[2] locator:入参,LOB协议中的loblocator。
[3] length:出参,存储获取到的数据总长度。
[4] 返回结果:YAC_SUCCESS为获取成功,YAC_ERROR为获取失败。
yacLobRead YacResult yacLobRead(YacHandle hConn, YacLobLocator* loc, YacUint64* bytes, YacUint8* buf, YacUint64 bufLen); LOB协议中,读取服务端LOB中的数据并下载到buf里 [1] hConn:记录与连接相关的多种信息的句柄。
[2] locator:入参,LOB协议中的loblocator。
[3] bytes:入参,数据总长度。
[4] buf:出参,存储读取到的数据。
[5] bufLen:预留参数,暂未在该接口中使用。
[6] 返回结果:YAC_SUCCESS为读取成功,YAC_ERROR为读取失败。
yacLobWrite YacResult yacLobWrite(YacHandle hConn, YacLobLocator* loc, YacUint64* bytes, YacUint8* buf, YacUint64 bufLen); LOB协议中,上传buf中的数据并存到服务端LOB里 [1] hConn:记录与连接相关的多种信息的句柄。
[2] locator:入参,LOB协议中的loblocator。
[3] bytes:预留参数,暂未在该接口中使用。
[4] buf:入参,用户需要上传的数据。
[5] bufLen:入参,用户上传数据的存储区长度。
[6] 返回结果:YAC_SUCCESS为写入成功,YAC_ERROR为写入失败。
分布式部署中不支持调用本接口将数据写至DN节点上,但支持将数据写入至CN节点的临时LOB中。
yacLobCreateTemporary YacResult yacLobCreateTemporary(YacHandle hConn, YacLobLocator* locator); LOB协议中,通知服务端创建临时lob [1] hConn:记录与连接相关的多种信息的句柄。
[2] locator:入参,LOB协议中的loblocator。
[3] 返回结果:YAC_SUCCESS为创建成功,YAC_ERROR为创建失败。
yacLobFreeTemporary YacResult yacLobFreeTemporary(YacHandle hConn, YacLobLocator* locator); LOB协议中,通知服务端释放临时lob [1] hConn:连接句柄。
[2] locator:入参,LOB协议中的loblocator。
[3] 返回结果:YAC_SUCCESS为释放成功,YAC_ERROR为释放失败。
yacLobIsTemporary YacResult yacLobIsTemporary(YacHandle hConn, YacLobLocator* locator, YacBool* isTemporary); LOB协议中,判断LOB是否为临时lob [1] hConn:连接句柄。
[2] locator:入参,LOB协议中的loblocator。
[3] isTemporary:YAC_TRUE为是临时LOB,YAC_FALSE为不是临时LOB。
[4] 返回结果:YAC_SUCCESS为操作成功,YAC_ERROR为操作失败。
yacLobTrim YacResult yacLobTrim(YacHandle hConn, YacLobLocator* locator, YacUint64* newlen); LOB协议中,截取LOB数据 [1] hConn:连接句柄。
[2] locator:入参,LOB协议中的loblocator。
[3] newlen:LOB要截取的新长度。
[4] 返回结果:YAC_SUCCESS为截取成功,YAC_ERROR为截取失败。
yacLobAppend YacResult yacLobAppend(YacHandle hConn, YacLobLocator* dstLob, YacLobLocator* srcLob); LOB协议中,将一个LOB追加到另一个LOB末尾 [1] hConn:连接句柄。
[2] dstLob:出入参,LOB协议中的loblocator,要追加数据的LOB。
[3] srcLob:入参,LOB协议中的loblocator,作为追加数据的LOB,目前只支持临时LOB。
[4] 返回结果:YAC_SUCCESS为追加成功,YAC_ERROR为追加失败。
yacLobCreateTemporary2 YacResult yacLobCreateTemporary2(YacHandle hConn, YacLobLocator* locator, YacUint8 lobtype); LOB协议中,通知服务端创建临时lob [1] hConn:记录与连接相关的多种信息的句柄。
[2] locator:入参,LOB协议中的loblocator。
[3] lobtype:LOB类型。
[4] 返回结果:YAC_SUCCESS为创建成功,YAC_ERROR为创建失败。
yacLobWriteAppend YacResult yacLobWriteAppend(YacHandle hConn, YacLobLocator* locator, YacUint64* byteSize, YacUint64* charSize, YacUint8* buf, YacUint64 bufLen); LOB协议中,将数据追加到LOB末尾 [1] hConn:连接句柄。
[2] locator:入参,LOB协议中的loblocator。
[3] byteSize:出入参,要写入数据的字节长度,对于clob在charSize不为零时自动忽略,返回写入数据的实际字节长度。
[4] charSize:出入参,要写入数据的字符长度,对于blob自动忽略,返回写入数据的实际字符长度。
[5] buf:入参,用户需要上传的数据。
[6] bufLen:入参,用户上传数据的存储区长度。
[7] 返回结果:YAC_SUCCESS为追加成功,YAC_ERROR为追加失败。
yacLobWrite2 YacResult yacLobWrite2(YacHandle hConn, YacLobLocator* locator, YacUint64* byteSize, YacUint64* charSize, YacUint64 offset, YacUint8* buf, YacUint64 bufLen); LOB协议中,从某个位置将数据插入到lob [1] hConn:连接句柄。
[2] locator:入参,LOB协议中的loblocator。
[3] byteSize:出入参,要写入数据的字节长度,对于clob在charSize不为零时自动忽略,返回写入数据的实际字节长度。
[4] charSize:出入参,要写入数据的字符长度,对于blob自动忽略,返回写入数据的实际字符长度。
[5] offset:入参,需要插入LOB的偏移位置。
[6] buf:入参,用户需要上传的数据。
[7] bufLen:入参,用户上传数据的存储区长度。
[8] 返回结果:YAC_SUCCESS为写入成功,YAC_ERROR为写入失败。
yacLobRead2 YacResult yacLobRead2(YacHandle hConn, YacLobLocator* locator, YacUint64* byteSize, YacUint64* charSize, YacUint64 offset, YacUint8* buf, YacUint64 bufLen); LOB协议中,从某个位置读取LOB数据 [1] hConn:连接句柄。
[2] locator:入参,LOB协议中的loblocator。
[3] byteSize:出入参,要读取数据的字节长度,对于clob在charSize不为零时自动忽略,返回读取数据的实际字节长度。
[4] charSize:出入参,要读取数据的字符长度,对于blob自动忽略,返回写入读取的实际字符长度。
[5] offset:入参,需要读取LOB的偏移位置。
[6] buf:出参,存储读取到的数据。
[7] bufLen:入参,存储读取到的存储区长度。
[8] 返回结果:YAC_SUCCESS为读取成功,YAC_ERROR为读取失败。
yacDescAlloc yacResult yacDescAlloc(yacHandle hConn, YacVoid** desc, YacAllocType type); LOB协议中,为loblocator分配空间 [1] hConn:记录与连接相关的多种信息的句柄。
[2] desc:出参,指向被分配空间的loblocator。
[3] type:入参,LOB类型。
[4] 返回结果:YAC_SUCCESS为分配空间成功,YAC_ERROR为分配空间失败。
yacDescFree yacResult yacDescFree(YacHandle hConn, YacVoid** desc, YacAllocType type); LOB协议中,为loblocator释放空间 [1] hConn:记录与连接相关的多种信息的句柄。
[2] desc:入参,指向loblocator。
[3] type:入参,LOB类型。
[4] 返回结果:YAC_SUCCESS为释放空间成功,YAC_ERROR为释放空间失败。
yacDateGetDate YacResult yacDateGetDate(const YacDate date, YacInt16* year, YacUint8* month, YacUint8* day); 获取存储于YacDate的年、月和日 [1] date:入参,YacDate类型时间戳
[2] year:出参,年。
[3] month:出参,月。
[4] day:出参,日。
[5] 返回结果:YAC_SUCCESS为获取成功,YAC_ERROR为获取失败。
yacShortTimeGetShortTime YacResult yacShortTimeGetShortTime(const YacShortTime time, YacUint8* hour, YacUint8* minute, YacUint8* second, YacUint32* fraction); 获取存储于YacShortTime的时、分和秒和微秒信息 [1] time:入参,YacShortTime类型时间戳。
[2] hour:出参,时。
[3] minute:出参,分。
[4] second:出参,秒。
[5] fraction:出参,微秒。
[6] 返回结果:YAC_SUCCESS为获取成功,YAC_ERROR为获取失败。
yacTimestampGetTimestamp YacResult yacTimestampGetTimestamp(const YacTimestamp timestamp, YacInt16* year, YacUint8* month, YacUint8* day, YacUint8* hour, YacUint8* minute, YacUint8* second, YacUint32* fraction); 获取存储于YacTimestamp的年、月、日、时、分、秒和微秒信息 [1] timestamp:入参,YacTimestamp类型时间戳。
[2] year:出参,年。
[3] month:出参,月。
[4] day:出参,日。
[5] hour:出参,时。
[6] minute:出参,分。
[7] second:出参,秒。
[8] fraction:出参,微秒。
[9] 返回结果:YAC_SUCCESS为获取成功,YAC_ERROR为获取失败。
yacYMIntervalGetYearMonth YacResult yacYMIntervalGetYearMonth(const YacYMInterval ymInterval, YacInt32* year, YacInt32* month); 获取存储于YacYMInterval的年、月信息 [1] ymInterval:入参,YacYMInterval类型时间差。
[2] year:出参,年。
[3] month:出参,月。
[4] 返回结果:YAC_SUCCESS为获取成功,YAC_ERROR为获取失败。
yacDSIntervalGetDaySecond YacResult yacDSIntervalGetDaySecond(const YacDSInterval dsInterval, YacInt32* day, YacInt32* hour, YacInt32* minute, YacInt32* second, YacInt32* fraction); 获取存储于YacDSInterval的日、时、分、秒和微秒信息 [1] dsInterval:入参,YacDSInterval类型时间差。
[2] day:出参,日。
[3] hour:出参,时。
[4] minute:出参,分。
[5] second:出参,秒。
[6] fraction:出参,微秒。
[7] 返回结果:YAC_SUCCESS为获取成功,YAC_ERROR为获取失败。
yacDateSetDate YacResult yacDateSetDate(YacDate* date, YacInt16 year, YacUint8 month, YacUint8 day); 用于设置YacDate的值 [1] date:出参,YacDate类型时间戳。
[2] year:入参,年。
[3] month:入参,月。
[4] day:入参,日。
[5] 返回结果:YAC_SUCCESS为设置成功,YAC_ERROR为设置失败。
yacShortTimeSetShortTime YacResult yacShortTimeSetShortTime(YacShortTime* time, YacUint8 hour, YacUint8 minute, YacUint8 second, YacUint32 fraction); 用于设置YacShortTime的值 [1] time:出参,YacShortTime类型时间戳。
[2] hour:入参,时。
[3] minute:入参,分。
[4] second:入参,秒。
[5] fraction:入参,微秒。
[6] 返回结果:YAC_SUCCESS为设置成功,YAC_ERROR为设置失败。
yacTimestampSetTimestamp YacResult yacTimestampSetTimestamp(YacTimestamp* timestamp, YacInt16 year, YacUint8 month, YacUint8 day, YacUint8 hour, YacUint8 minute, YacUint8 second, YacUint32 fraction); 用于设置YacTimestamp的值 [1] timestamp:出参,YacTimestamp类型时间戳。
[2] year:入参,年。
[3] month:入参,月。
[4] day:入参,日。
[5] hour:入参,时。
[6] minute:入参,分。
[7] second:入参,秒。
[8] fraction:入参,微秒。
[9] 返回结果:YAC_SUCCESS为设置成功,YAC_ERROR为设置失败。
yacYMIntervalSetYearMonth YacResult yacYMIntervalSetYearMonth(YacYMInterval* ymInterval, YacInt32 year, YacInt32 month); 用于设置YacYMInterval的值 [1] ymInterval:出参,YacYMInterval类型时间差。
[2] year:入参,年。
[3] month:入参,月。
[4] 返回结果:YAC_SUCCESS为设置成功,YAC_ERROR为设置失败。
yacDSIntervalSetDaySecond YacResult yacDSIntervalSetDaySecond(YacDSInterval* dsInterval, YacInt32 day, YacInt32 hour, YacInt32 minute, YacInt32 second, YacInt32 fraction); 用于设置YacDSInterval的值 [1] dsInterval:出参,YacDSInterval类型时间差。
[2] day:入参,日。
[3] hour:入参,时。
[4] minute:入参,分。
[5] second:入参,秒。
[6] fraction:入参,微秒。
[7] 返回结果:YAC_SUCCESS为设置成功,YAC_ERROR为设置失败。
yacRowIdToText YacResult yacRowIdToText(YacRowId* rowId, YacChar* str, YacInt32 bufLength, YacInt32* length); 用于RowId类型转换到String类型 [1] rowId:入参,YacRowId类型指针。
[2] str:出参,字符串buffer地址。
[3] bufLength:入参,字符串buffer长度。
[4] length:出参,用于获取字符串实际长度,可为NULL。
[5] 返回结果:YAC_SUCCESS为转换成功,YAC_ERROR为转换失败。
yacTextToRowId YacResult yacTextToRowId(YacChar* str, YacInt32 length, YacRowId* rowId); 用于String类型转换到RowId类型 [1] str:入参,字符串buffer地址。
[2] length:入参,字符串实际长度。
[3] rowId:出参,YacRowId类型指针,用于存放输出的YacRowId。
[4] 返回结果:YAC_SUCCESS为转换成功,YAC_ERROR为转换失败。
yacNumberRound YacResult yacNumberRound(YacNumber* n, YacInt32 precision, YacInt32 scale); 用于设置YacNumber的precision和scale [1] n:入参、出参,存放number类型的值。
[2] precision:入参,精度。
[3] scale:入参,小数位数。
[4] 返回结果:YAC_SUCCESS为设置成功,YAC_ERROR为设置失败。
yacGetData YacResult yacGetData(YacHandle hStmt, YacUint16 id, YacUint32 rowNumber, YacUint32 extType, YacPointer value, YacInt32 bufLen, YacInt32* indicator); 用于客户端从已缓存的结果集中获取数据 [1] hStmt:SQL信息句柄。
[2] id:入参,列的编号索引(0表示第1列)。
[3] rowNumber:入参,要获取的已缓存结果集的行序号,从1开始。
[4] type:入参,要获取已缓存结果集的列序号。
[5] value:入参,要获取已缓存结果集的缓冲区。
[6] bufLen:入参,要获取已缓存结果集的缓冲区宽度。
[7] indicator:出入参,辅助指针,作为入参,其值是要获取已缓存结果集的长度。此时对于非变长类型(包括使用lobLocator绑定的类型),其值不生效。作为出参,其值表示结果集取值情况。该指针可赋为为NULL,表示不生效。
[8] 返回结果:YAC_SUCCESS为获取成功,YAC_ERROR为获取失败。
下载文档
复制链接