|
Usage type
|
Meaning
|
|---|---|
|
in
|
Indicates the parameter is input.
|
|
output
|
Indicates the parameter is output.
|
|
in out
|
Indicates the parameter is input/output
|
|
use
|
Applies only to a pointer parameter. It means that the parameter is used during the function call. The caller can do whatever it wants with the parameter after the function call. use is the most common type of parameter passing.
|
|
take
|
Applies only to a pointer parameter. It means that the parameter value is taken by the function. The caller cannot reference the parameter after the function call. The function or an object created in the function is responsible for releasing the parameter when it is no longer needed.
|
|
hold
|
Applies only to a pointer parameter. It means that the function holds the parameter value even after the function call. The caller can continue to reference the parameter value after the function call and is responsible for releasing the parameter.
Note Because this parameter is shared by the user and the server, you must not release it until the server is finished with it. In general, you can free the held object after you free the object that is holding it. For example:
conn = SaConnect("", "dba", "dba");
/* Connection is held until cursor is freed */ scur = SaCursorCreate(conn, "mytable"); ... SaCursorFree(scur); /* After we free the cursor, it is safe to free */ /* the connection (or, as in this case, call a */ /* server function that frees the connection). */ SaDisconnect(conn); |
|
Error code/message
|
Description
|
|---|---|
|
SSC_SUCCESS
|
Operation is successful.
|
|
SSC_ERROR
|
Generic error.
|
|
SSC_ABORT
|
Operation cancelled.
|
|
SSC_FINISHED
|
SSCAdvanceTasks returns this message if all tasks are executed.
|
|
SSC_CONT
|
SSCAdvanceTasks returns this message if there are still more tasks to execute.
|
|
SSC_CONNECTIONS_EXIST
|
There are open connections.
|
|
SSC_UNFINISHED_TASKS
|
There are unfinished tasks.
|
|
SSC_INFO_SERVER_RUNNING
|
The server is already running.
|
|
SSC_INVALID_HANDLE
|
Invalid local server handle given. This server does not match the one started through SSCStartServer.
|
|
SSC_INVALID_LICENSE
|
No license or invalid license file found.
|
|
SSC_NODATABASEFILE
|
No database file found.
|
|
SSC_SERVER_NOTRUNNING
|
The server is not running.
|
|
SSC_SERVER_INNETCOPYMODE
|
The server is in netcopy mode (applies only with HotStandby).
|