Expand Minimize

MappingGetServices function

Retrieves a list of available ELS platform-supported services, along with associated information, according to application-specified criteria.

Syntax


HRESULT MappingGetServices(
  _In_opt_  PMAPPING_ENUM_OPTIONS pOptions,
  _Out_     PMAPPING_SERVICE_INFO *prgServices,
  _Out_     DWORD *pdwServicesCount
);

Parameters

pOptions [in, optional]

Pointer to a MAPPING_ENUM_OPTIONS structure containing criteria to use during enumeration of services. The application specifies NULL for this parameter to retrieve all installed services.

prgServices [out]

Address of a pointer to an array of MAPPING_SERVICE_INFO structures containing service information matching the criteria supplied in the pOptions parameter.

pdwServicesCount [out]

Pointer to a DWORD variable in which this function retrieves the number of retrieved services.

Return value

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

Note  The application must test for any failure before proceeding with further operations.

Remarks

The ELS application can either retrieve all services or filter the services according to specified options. For an associated procedure and code sample, see Enumerating and Freeing Services.

To avoid resource leaks, the application must free the pointer indicated by prgServices with a call to MappingFreeServices.

For performance reasons, it is recommended to retrieve services infrequently. For example, if the application needs a specific service, by GUID, it can be enumerated when needed and cached for future use.

Requirements

Minimum supported client

Windows 7 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 R2 [desktop apps | Windows Store apps]

Header

Elscore.h

Library

Elscore.lib

DLL

Elscore.dll

See also

Extended Linguistic Services
Extended Linguistic Services Functions
Enumerating and Freeing Services
MappingFreeServices
MAPPING_ENUM_OPTIONS
MAPPING_SERVICE_INFO

 

 

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.