PvGetDbNamesData()
Retrieves the number of database names for a connected server. Use the
PvGetDbName() function to enumerate the names.
Header File: catalog.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_API PvGetDbNamesData(
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 database names on the server. |
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 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.
This function should be called first before calling any other functions to get database names information. The caller should call
PvFreeDbNamesData() to free the resources allocated for database names.
See Also