Function First Available In Library: w3dbav75.dll (Windows), libpsqldti.so (Linux), libpsqldti.dylib (macOS) (See also Link Libraries)
Syntax
BTI_SINT PvGetSQLConnectionsData(
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 SQL connections.
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 SQL connections. This function should be called first before calling any other functions to get SQL connection information.
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.
The following post conditions must be met:
•The caller should call PvFreeSQLConnectionsData() to free the cached information when it is no longer needed.