PvIsSettingAvailable()
Query to see if a setting is available for configuring.
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 PvIsSettingAvailable(
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. |
Return Values
Zero | Setting is unavailable. |
Non-zero | Setting is available. |
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.
Setting may be unavailable due to insufficient rights to access the setting or if no such setting ID exist.
See Also