OCILobFileGetName()

Purpose

Gets the FILE locator's directory alias and file name.

Syntax

sword OCILobFileGetName ( OCIEnv                   *envhp,
                          OCIError                 *errhp, 
                          CONST OCILobLocator      *filep, 
                          text                     *dir_alias,
                          ub2                      *d_length, 
                          text                     *filename, 
                          ub2                      *f_length );

Parameters

envhp (IN/OUT)

OCI environment handle.

errhp (IN/OUT)

An error handle you can pass to OCIErrorGet() for diagnostic information in the event of an error.

filep (IN)

FILE locator for which to get the directory alias and file name.

dir_alias (OUT)

Buffer into which the directory alias name is placed. This can be in UTF-16. You must allocate enough space for the directory alias name. The maximum length for the directory alias is 30 bytes.

d_length (IN/OUT)

Serves the following purposes (can be in codepoint for Unicode, or bytes):

• IN: length of the input dir_alias string
• OUT: length of the returneddir_alias string

filename (OUT)

Buffer into which the file name is placed. You must allocate enough space for the file name. The maximum length for the file name is 255 bytes.

f_length (IN/OUT)

Serves the following purposes (in number of bytes):

• IN: length of the input filename buffer
• OUT: length of the returned filename string

Comments

Returns the directory alias and file name associated with this FILE locator. The environment handle determines whether or not it is in Unicode. It is an error to call this function for an internal LOB.

Related Functions

OCILobFileSetName(), OCIErrorGet()