PvGetFileInfo()
Query the information for 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 PvGetFileInfo(
BTI_LONG hConnection,
BTI_CHAR_PTR fileName,
PVFILEINFO* pFileInfo);
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 | pFileInfo | Address of a
PVFILEINFO structure to receive the information on the 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 for other reasons. |
Remarks
The following preconditions 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.
•Caller already has a valid open file name.
See Also