GetFirstOrderedService

[This is preliminary documentation and subject to change.]

The GetFirstOrderedService function returns the first service in the specified order from the designated subset of services in the table.

DWORD GetFirstOrderedService (
  IN DWORD               OrderingMethod,
  IN DWORD               ExclusionFlags,
  IN OUT PIPX_SERVICE    Service
  );
 

Parameters

OrderingMethod

Indicates the order in which the services will be searched. This parameter must be one of the following values.

STM_ORDER_BY_TYPE_AND_NAME

Services will be searched in type.name order

STM_ORDER_BY_INTERFACE_TYPE_NAME

Services will be searched in interface index.type.name order.

ExclusionFlags

Limits the set of examined services to a subset defined by ExclusionFlags and the values in the corresponding fields of Service. See CreateServiceEnumerationHandle for a description of the possible flags.

Service

Points to an IPX_SERVICE structure.

Value of Service at Input:

Values in the fields correspond to flags specified in ExclusionFlags.

Value of Service upon Output:

The first service that matches specified criteria.

Return Values

NO_ERROR

A matching service was found and placed in the structure pointed to by Service.

ERROR_NO_MORE_ITEMS

No services matching the specified criteria exist.

ERROR_INVALID_PARAMETER

One or more input parameters are invalid, that is,invalid ordering method, enumeration flags, or field values in Service.

QuickInfo

  Windows NT: Use version 5.0 and later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in user-defined.
  Import Library: user-defined.

See Also

CreateServiceEnumerationHandle, IPX_SERVICE