OCIBreak
Description : You can call this function to execute an immediate (asynchronous) termination of a currently executing OBCI function that has been associated with a server.
Function prototype :
sword OCIBreak (
void *hndlp,
OCIError *errhp );
Parameters :
| Parameter | Description |
|---|---|
| hndlp(IN/OUT) | A handle to the service context or server. |
| errhp (IN/OUT) | An error handle. |
Return value : OCI_SUCCESS if succeeded, or OCI_ERROR if failed.
OCIClientVersion
Description : You can call this function to return the version of the client library at runtime.
Function prototype :
void OCIClientVersion (
sword *major_version,
sword *minor_version,
sword *update_num,
sword *patch_num,
sword *port_update_num );
Parameters :
| Parameter | Description |
|---|---|
| major_version(OUT) | The major version of the client library. |
| minor_version(OUT) | Minor version of the client library. |
| update_num(OUT) | The update number of the client library. |
| patch_num(OUT) | The patch number that has been applied to the client library. |
| port_update_num(OUT) | The port update number, which is the port-specific patch applied to the library. |
Return value : NULL.
OCIErrorGet
Description : You can call this function to return an error message in the buffer provided and an OceanBase error code.
Function prototype :
sword OCIErrorGet (
void *hndlp,
ub4 recordno,
OraText *sqlstate,
sb4 *errcodep,
OraText *bufp,
ub4 bufsiz,
ub4 type );
Parameters :
| Parameter | Description |
|---|---|
| hndlp (IN) | An error handle or environment handle. |
| recordno (IN) | Indicates the status record from which the application seeks information. The value starts from 1. |
| sqlstate (OUT) | Not supported. |
| errcodep (OUT) | Returns the error code. |
| bufp (OUT) | Returns the error message text. |
| bufsiz (IN) | The size of the buffer provided to receive the error message, in bytes. |
| type (IN) | The type of the handle. Valid values: OCI_HTYPE_ERR or OCI_HTYPE_ENV. |
Return value : OCI_SUCCESS if succeeded, or OCI_ERROR if failed.
OCIPasswordChange
Description : You can call this function to change the account password.
Function prototype :
sword OCIPasswordChange (
OCISvcCtx *svchp,
OCIError *errhp,
const OraText *user_name,
ub4 usernm_len,
const OraText *opasswd,
ub4 opasswd_len,
const OraText *npasswd,
sb4 npasswd_len,
ub4 mode );
Parameters :
| Parameter | Description |
|---|---|
| svchp (IN/OUT) | A service context handle. |
| errhp (IN) | An error handle. |
| user_name (IN) | Specifies the username, which can be in UTF-16 encoding. |
| usernm_len (IN) | Specifies the length of the username. |
| opasswd (IN) | The old username. |
| opasswd_len (IN) | Specifies the length of the old username. |
| npasswd (IN) | The new username. |
| npasswd_len (IN) | Specifies the length of the new username. |
| mode (IN) | Use the settings in the environment handle. Default value: OCI_DEFAUL. |
Return value : OCI_SUCCESS if succeeded, or OCI_ERROR if failed.
OCIPing
Description : You can call this function to make a round trip call to the server to confirm that the connection and the server are active.
Function prototype :
sword OCIPing (
OCISvcCtx *svchp,
OCIError *errhp,
ub4 mode );
Parameters :
| Parameter | Description |
|---|---|
| svchp (IN) | A service context handle. |
| errhp (IN) | An error handle. |
| mode(IN) | The mode of the operation. Default value: OCI_DEFAUL. |
Return value : OCI_SUCCESS if succeeded, or OCI_ERROR if failed.
