Edit

IIdentityProvider::Advise method (identityprovider.h)

  • Article

The Advise method allows a calling application to specify the list of identity events for which the application is to be notified.

Syntax

HRESULT Advise(
  [in]  IIdentityAdvise *pIdentityAdvise,
  [in]  DWORD           dwIdentityUpdateEvents,
  [out] DWORD           *pdwCookie
);

Parameters

[in] pIdentityAdvise

A pointer to the IIdentityAdvise interface implemented by the calling application. This interface provides a method that the identity provider can call when one of the events specified by the dwIdentityUpdateEvents parameter occurs.

[in] dwIdentityUpdateEvents

The identity events for which the calling application is to be notified. The value of this parameter can be zero or more of the following values combined by using a bitwise-OR operation.

Value Meaning
IDENTITY_ASSOCIATED
0X0001
 An identity was associated with the identity provider.
IDENTITY_DISASSOCIATED
0X0002
 An identity was disassociated from the identity provider.
IDENTITY_CREATED
0X0004
 A new identity was created.
IDENTITY_IMPORTED
0X0008
 An identity was imported from another identity provider.
IDENTITY_DELETED
0X0010
 An identity was deleted from the identity store.
IDENTITY_PROPCHANGE
0X0020
 The value of a property of an identity changed.

[out] pdwCookie

A pointer to a value that identifies this connection. When you have finished using this connection, delete it by passing this value to the UnAdvise method.

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

Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header identityprovider.h

See also

IIdentityAdvise::IdentityUpdated

IIdentityProvider