PvGetSQLConnectionInfo()

Distributed Tuning Interface Reference : PvGetSQLConnectionInfo()

Query the information for a SQL connection.

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 PvGetSQLConnectionInfo(

BTI_LONG hConnection,

BTI_ULONG sequence,

PVSQLCONNINFO* pSQLConnInfo);

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 SQL connection. Must be within a valid range with upper limit defined by the number of SQL connections obtained by PvGetSQLConnectionsData().
Out	pSQLConnInfo	Address of a PVSQLCONNINFO structure to receive the information on the SQL connection.

Return Values

P_OK	The operation was successful.
P_E_INVALID_HANDLE	hConnection parameter is not a valid connection handle.
P_E_DATA_UNAVAILABLE	Data not available for the SQL connection.
P_E_NULL_PTR	pSQLConnInfo pointer is NULL.
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 SQL connections retrieved by calling PvGetSQLConnectionsData()

•Caller already has a valid SQL connection sequence.