PvGetSettingHelp()

Distributed Tuning Interface Reference : PvGetSettingHelp()

PvGetSettingHelp()

Retrieves help string related to 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 PvGetSettingHelp(

BTI_ULONG settingID,

BTI_ULONG_PTR pBufSize,

BTI_CHAR_PTR pHelpString);

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.
Out	pHelpString	String value returned.

Return Values

P_OK	The operation was successful.
P_E_NULL_PTR	Call with NULL pointer.
P_E_BUFFER_TOO_SMALL	The buffer allocated is too small and the display string is truncated. In this case, the required buffer size is returned in pBufSize.
P_E_FAIL	Failed for other reasons.

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.