PvFreeDbNamesData()
Free the resource allocated for database names on a connected server. This function needs to be called after preceding calls to PvGetDbNamesData.
Header File: catalog.h (See also
Header Files
)
Function First Available In Library: w3dbav75.dll (Windows), libpsqldti.so (Linux), libpsqldti.dylib (OS X) (See also
Link Libraries
)
Syntax
BTI_API PvFreeDbNamesData(
BTI_LONG
hConnection);
Arguments
In
hConnection
Connection handle that identifies the server. Connection handles are obtained with the
PvConnectServer()
function.
Return Values
P_OK
The operation was successful.
P_E_INVALID_HANDLE
Invalid connection handle.
P_E_DATA_UNAVAILABLE
Data related to database names not available.
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.
•
Database names data retrieved by calling
PvGetDbNamesData()
.
See Also
PvStart()
PvConnectServer()
PvGetDbNamesData()
PvGetDbName()
PvDisconnect()
PvStop()