CHAI SDK  Version 1.3
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
CPNS::IRemoteDevice_GetSelectorParameterValueText_AsyncReturnHandler Class Referenceabstract

Notification handler for RemoteDevice's GetSelectorParameterValueText async method. More...

Public Member Functions

virtual void OnRemoteDevice_GetSelectorParameterValueText_Return (CPNS::IAsync *const pAsync, CPNS::Enums::AsyncResult const result, CPNS::IListID *const pSelectorItemListID, CPNS::uint16 const wItemIndex, CPNS::uint16 const wValue, CPNS::char8 const *const utf8Text)=0
 Selector parameter item value + text info. More...
 

Detailed Description

Notification handler for RemoteDevice's GetSelectorParameterValueText async method.

Member Function Documentation

virtual void CPNS::IRemoteDevice_GetSelectorParameterValueText_AsyncReturnHandler::OnRemoteDevice_GetSelectorParameterValueText_Return ( CPNS::IAsync *const  pAsync,
CPNS::Enums::AsyncResult const  result,
CPNS::IListID *const  pSelectorItemListID,
CPNS::uint16 const  wItemIndex,
CPNS::uint16 const  wValue,
CPNS::char8 const *const  utf8Text 
)
pure virtual

Selector parameter item value + text info.

Parameters
[in]pAsyncPointer to the async operation handler. Can be used to match the return notification with the related async operation.
[in]resultAsync operation result. Can be CPNS::Enums::AR_Done if no more item, CPNS::Enums::AR_Succeeded if the returned item is unique. The following values can be passed if the request's fRequestMultipleValues was TRUE: CPNS::Enums::AR_MoreItemsAvailable if the item is valid and more items are pending (do not request the rest of the list at this time, this notification will be called at least once with the same pAsync), CPNS::Enums::AR_LastBatchItem if this is the last item for this batch (at this time you can initiate a new request to get the next items).
[in]pSelectorItemListIDthe Selector Item List ID. Don't forget to Acquire() it if the application needs to keep it for later use.
[in]wItemIndexthe index
[in]wValuethe item's value, this is the value to be sent inside a Selector message to activate the queried item.
[in]utf8Textthe item's display string
Warning
Beware of result to determine if your local copy of pAsync will become invalid or not!