PvGetFileHandlesData()

Distributed Tuning Interface Reference : PvGetFileHandlesData()

Retrieves all the file handle information related to 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 PvGetFileHandlesData(

BTI_LONG hConnection,

BTI_CHAR_PTR fileName,

BTI_ULONG_PTR pCount);

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.
Out	pCount	Address of an unsigned long to receive the number of handles for the open file.

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_FILE_NOT_OPEN	Specified file is not currently open.
P_E_FAIL	Failed to disconnect to the named server.

Remarks

The information will be cached by DTI for subsequent calls related to file handles. This function would be called first for an open file before calling any other functions to get file handle information. The cached information for the file handles will be freed when PvFreeOpenFilesData() is called.

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()

•Caller already has a valid open file name.