PvGetSettingInfo()
Retrieves setting information for a setting.
Header File: config.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 PvGetSettingInfo(
BTI_LONG hConnection,
BTI_ULONG settingID,
Arguments
In | hConnection | Connection handle that identifies the server. Connection handles are obtained with the
PvConnectServer() function. |
In | settingID | Unique identifier for the setting. A list of settings can be obtained from
PvGetSettingList(). |
Out | pSettingInfo | Address of a
PVSETTINGINFO structure that receives setting information. |
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 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.
See Also