PvGetOpenFilesData()
Retrieves all the information related to the open files.
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 PvGetOpenFilesData(
BTI_LONG hConnection,
BTI_ULONG_PTR pCount);
Arguments
In | hConnection | Connection handle that identifies the server. Connection handles are obtained with the
PvConnectServer() function. |
Out | pCount | Address of an unsigned long to receive the number of open files. |
Return Values
P_OK | The operation was successful. |
P_E_INVALID_HANDLE | Invalid connection handle. |
P_E_NULL_PTR | Call with NULL pointer. |
P_E_FAIL | Failed for other reasons. |
Remarks
The information will be cached by DTI for subsequent calls related to open files. This function should be called first before calling any other functions to get open file information.
The following precondition must be met:
•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.
The following post condition must be met:
•The caller should call
PvFreeOpenFilesData() to free the cached information when it is no longer needed.
See Also