IVdsService::Advise method

[Beginning with Windows 8 and Windows Server 2012, the Virtual Disk Service COM interface is superseded by the Windows Storage Management API.]

Registers the caller's IVdsAdviseSink interface with VDS so that the caller receives notifications from the VDS service.

Syntax

HRESULT Advise(
  IVdsAdviseSink *pSink,
  DWORD          *pdwCookie
);

Parameters

pSink

A pointer to the IVdsAdviseSink interface.

pdwCookie

A pointer to a cookie that can later be used to unregister the interface.

Return Value

This method can return standard HRESULT values, such as E_INVALIDARG or E_OUTOFMEMORY, and VDS-specific return values. It can also return converted system error codes using the HRESULT_FROM_WIN32 macro. Errors can originate from VDS itself or from the underlying VDS provider that is being used. Possible return values include the following.

Return code/value Description
S_OK
The registration completed successfully.
VDS_E_INITIALIZED_FAILED
0x80042401L
VDS failed to initialize. If an application calls this method before the service finishes initializing, the method is blocked until the initialization completes. If the initialization fails, this error is returned.

Remarks

To receive notifications from the VDS service, your application must implement the IVdsAdviseSink interface and use the Advise method to register the interface.

To stop receiving notifications from the VDS service, use the IVdsService::Unadvise method to unregister the IVdsAdviseSink interface.

Note  An application that calls Advise must eventually call Unadvise. Ideally, it should call Unadvise as soon as it no longer needs to receive notifications.
 
To receive notifications from underlying software and hardware providers, VDS passes a notification callback function to each provider as a parameter of the IVdsProviderPrivate::OnLoad method.

Requirements

   
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header vds.h
Library Uuid.lib

See Also

IVdsAdviseSink

IVdsProviderPrivate::OnLoad

IVdsService

VDS Notifications