This topic has not yet been rated - Rate this topic

IIdentityProvider::GetIdentityEnum method

The GetIdentityEnum method retrieves an IEnumUnknown interface pointer that can be used to enumerate identities.

Syntax

C++


HRESULT GetIdentityEnum(
  [in]            const IDENTITY_TYPE eIdentityType,
  [in, optional]  const PROPERTYKEY *pFilterkey,
  [in, optional]  const PROPVARIANT *pFilterPropVarValue,
  [out]           IEnumUnknown **ppIdentityEnum
);

Parameters

eIdentityType [in]: A value of the IDENTITY_TYPE enumeration that indicates the type of identities to enumerate.
pFilterkey [in, optional]: A pointer to a property key that specifies a property. If the value of this parameter is not NULL, only identities that support the property specified by this parameter are enumerated.
pFilterPropVarValue [in, optional]: A pointer to a property value. If the values of this parameter and the pFilterkey parameter are not NULL, only identities that have the property value specified by this parameter are enumerated.
ppIdentityEnum [out]: A pointer to an IEnumUnknown interface pointer that can be used to enumerate identities.

Return value

If the method succeeds, it returns S_OK.

If the method fails, it returns an error code. For a list of common error codes, see Common HRESULT Values.

Requirements

Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Header	Identityprovider.h
IDL	Identityprovider.idl
IID	IID_IIdentityProvider is defined as 0d1b9e0c-e8ba-4f55-a81b-bce934b948f5

Community Additions