PvGetSettingHelpSize()
Retrieves help string related to setting.
Header File: config.h (See also
Header Files
)
Function First Available In Library: w3dbav78.dll (Windows), libpsqldti.so (Linux), libpsqldti.dylib (OS X) (See also
Link Libraries
)
Syntax
BTI_SINT PvGetSettingHelpSize(
BTI_ULONG
settingID,
BTI_ULONG_PTR
pBufSize
);
Arguments
In
settingID
Unique identifier for the setting. A list of settings can be obtained from
PvGetSettingList()
.
In/Out
pBufSize
Address of an unsigned long containing size of buffer allocated to receive setting value. Receives actual size of setting value. The size should include the NULL terminator.
Return Values
P_OK
The operation was successful.
P_E_NULL_PTR
Call with NULL pointer.
Remarks
The following preconditions must be met:
•
DTI session started by calling
PvStart()
.
•
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
PvStart()
PvConnectServer()
PvGetCategoryList()
PvGetSettingList()
PvGetSettingInfo()
PvDisconnect()
PvStop()