PvGetLongValue()
Retrieves the value for a long integer type setting, from the data source specified by whichData.
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 PvGetLongValue(
BTI_LONG hConnection,
BTI_ULONG settingID,
BTI_LONG_PTR pValue,
BTI_SINT whichData);
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 | pValue | Address of a long integer variable that receives the setting value. |
In | whichData | Flag to indicate which value is requested: PVDATA_DEFAULT returns default value.
PVDATA_CURRENT returns current value |
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_INVALID_DATA_TYPE | The requested setting is not of long integer type. |
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.
To obtain the minimum and maximum values that the setting can accept, use the
PvGetValueLimit() function.
See Also