MappingDoAction function

Causes an ELS service to perform an action after text recognition has occurred. For example, a phone dialer service first must recognize phone numbers and then can perform the "action" of dialing a number.

Syntax

C++
Copy 

HRESULT MappingDoAction(
  _Inout_ PMAPPING_PROPERTY_BAG pBag,
  _In_    DWORD                 dwRangeIndex,
  _In_    LPCWSTR               pszActionId
);

Parameters

pBag [in, out]

Pointer to a MAPPING_PROPERTY_BAG structure containing the results of a previous call to MappingRecognizeText. This parameter cannot be set to NULL.

dwRangeIndex [in]

A starting index inside the text recognition results for a recognized text range. This value should be between 0 and the range count.

pszActionId [in]

Pointer to the identifier of the action to perform. This parameter cannot be set to NULL.

Return value

Returns S_OK if successful. The function returns an error HRESULT value if it does not succeed.

Remarks

The application must precede the call to MappingDoAction with a call to MappingRecognizeText.

Warning  The data referred to by the pszText and pOptions arguments passed to MappingRecognizeText must remain valid until the property bag structure passed by pBag is freed via MappingFreePropertyBag. This is because both synchronous and asynchronous calls to MappingRecognizeText and MappingDoAction will attempt to use the data passed to the initial call to MappingRecognizeText.
 

Requirements

Minimum supported client

Windows 7 [desktop apps only]

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header
Elscore.h

Library
Elscore.lib

DLL
Elscore.dll

See also

Extended Linguistic Services
Extended Linguistic Services Functions
MappingRecognizeText
MAPPING_PROPERTY_BAG

 

 

Show: