PvGetFileHandleInfo()

Distributed Tuning Interface Reference : PvGetFileHandleInfo()

Query the information for a file handle associated with an open file.

Header File: monitor.h (See also Header Files)

Function First Available In Library: w3dbav75.dll (Windows), libpsqldti.so (Linux), libpsqldti.dylib (macOS) (See also Link Libraries)

Syntax

BTI_SINT PvGetFileHandleInfo(

BTI_LONG hConnection,

BTI_CHAR_PTR fileName,

BTI_ULONG sequence,

PVFILEHDLINFO* pFileHdlInfo);

Arguments

In	hConnection	Connection handle that identifies the server. Connection handles are obtained with the PvConnectServer() function.
In	fileName	Full path name of the file to be queried.
In	sequence	The sequence number (zero-based) of the file handle. Must be within a valid range with upper limit defined by the number of file handles obtained by PvGetFileHandlesData().
Out	pFileHdlInfo	Address of a PVFILEHDLINFO structure to receive the information on the file handle.

Return Values

P_OK	The operation was successful.
P_E_INVALID_HANDLE	Invalid connection handle.
P_E_DATA_UNAVAILABLE	Data related to active clients not available.
P_E_NULL_PTR	Call with NULL pointer
P_E_INVALID_SEQUENCE	Sequence number is not valid
P_E_FILE_NOT_OPEN	Specified file is not currently open.
P_E_FAIL	Failed to disconnect to the named server.

Remarks

The following preconditions must be met:

•DTI session started by calling PvStart().

•Connection established by PvConnectServer() or if you are performing the operation on a local machine, P_LOCAL_DB_CONNECTION may be used as the connection handle.

•Data for open files retrieved by calling PvGetOpenFilesData()

•Data for open file handles retrieved by calling PvGetFileHandlesData();

•Caller already has a valid open file name.

•Caller already has a valid file handle sequence.