PvGetOpenFileName()

Distributed Tuning Interface Reference : PvGetOpenFileName()

PvGetOpenFileName()

Retrieves the full path name of 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 PvGetOpenFileName(

BTI_LONG hConnection,

BTI_ULONG sequence,

BTI_ULONG_PTR pBufSize,

BTI_CHAR_PTR fileName);

Arguments

In	hConnection	Connection handle that identifies the server. Connection handles are obtained with the PvConnectServer() function.
In	sequence	The sequence number (zero based) of the file. Must be within a valid range with upper limit returned by PvGetOpenFilesData().
In/Out	pBufSize	Address of an unsigned long containing size of buffer allocated to receive the file name. Receives actual size of chars copied. The size should include the null terminator.
In/Out	fileName	String value returned.

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_BUFFER_TOO_SMALL	Allocated buffer is too small for the string, returned string is truncated. In this case the required size is in pBufSize.
P_E_INVALID_SEQUENCE	Sequence number is not valid.
P_E_FAIL	Failed to disconnect to the named server.

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.

•Data for open files retrieved by calling PvGetOpenFilesData().