CHAILink SDK  Version 1.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
CLC_ErrorCode RemoteDevice_GetIndexListItem_Async ( CPHOOKEDOBJECT const  hRemoteDevice,
CPHOOKEDOBJECT const  hIndexListID,
CPUINT16 const  wIndex,
CPBOOLEAN const  fRequestMultipleValues,
CPUINT32 const  dwClientContextData,
CPHASYNC *const  phAsync 
)

Get Index display text.

Parameters
[in]hRemoteDeviceHandle to the remote device.
[in]hIndexListIDThe list ID
[in]wIndexThe index value, from 1 to index max for the related message.
[in]fRequestMultipleValuesTRUE if multiple consecutive values from wMsgIndex are requested.
[in]dwClientContextDataData passed back to the ARH_REMOTEDEVICE_GETINDEXLISTITEM callback handler.
[out]phAsyncPointer to the handle of the async operation.
Returns
Standard CHAILink Client return code. See CLC_ErrorCode enumeration.
Warning
This function can only be called in CopperLan context. This means in the pseudo task CPDoProcess(), in notification handlers or in asynchronous return handlers and not in SystemDoProcess() for instance.