Oracle Call Interface Programmer's Guide Release 9.0.1 Part Number A89857-01 |
|
This chapter completes description of the OCI relational functions started in the last chapter. It includes information about calling OCI functions in your application, along with detailed descriptions of each function call. This chapter contains the following sections:
This chapter completes descriptions of the OCI relational function calls. It continues from the last chapter. The function calls for manipulating objects are described in the next three chapters.
See Also:
For information about return codes and error handling, refer to the section "Error Handling" |
For each function, the following information is listed:
A brief description of the action performed by the function.
The function declaration.
A description of each of the function's parameters. This includes the parameter's mode. The mode of a parameter has three possible values, as described below.
More detailed information about the function (if available). This may include restrictions on the use of the function, or other information that might be useful when using the function in an application.
A complete or partial code example demonstrating the use of the function call being described. Not all function descriptions include an example.
A list of related function calls.
Unlike earlier versions of the OCI, in release 8 you cannot pass -1 for the string length parameter of a null-terminated string.
When you pass string lengths as parameters, do not include the null terminator byte in the length. The OCI does not expect strings to be null-terminated.
Buffer lengths that are OCI parameters are in bytes, except the amount parameters in some LOB calls, which are in characters.
For a table showing the number of server round- trips required for individual OCI LOB functions, refer to Appendix C, "OCI Function Server Round-trips".
This section describes the LOB functions.
Note the following for parameters in the OCI LOB calls:
CLOBs
and NCLOBs
, and in bytes for BLOBs
and BFILEs
.
amtp
) parameter - When the amount parameter refers to the server-side LOB, the amount is in characters. When the amount parameter refers to the client-side buffer, the amount is in bytes. For more information, see individual LOB calls, such as
OCILobGetLength()
,
OCILobRead()
, and
OCILobWrite()
.
offset
) parameter - Regardless of whether the client-side character set is varying-width, the offset parameter is always in characters for CLOBs
and NCLOBs
and in bytes for BLOBs
and BFILEs
.
CLOBs
and NCLOBs
. These LOB operations include OCILobCopy()
, OCILobErase()
, OCILobGetLength()
, OCILobLoadFromFile()
, and OCILobTrim()
. All these operations refer to the amount of LOB data on the server.
A streaming operation means that the LOB is read or written in pieces. Streaming can be implemented using a polling mechanism or by registering a user-defined callback.
|
Copyright © 1996-2001, Oracle Corporation. All Rights Reserved. |
|