Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IVdsService::Unadvise method

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

Unregisters the caller's IVdsAdviseSink interface so that the caller no longer receives notifications from the VDS service.

Syntax


HRESULT Unadvise(
  [in]  DWORD dwCookie
);

Parameters

dwCookie [in]

The cookie that was returned by the IVdsService::Advise method when the IVdsAdviseSink interface was registered.

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/valueDescription
S_OK

The method completed successfully.

VDS_E_BAD_COOKIE
0x80042411L

The cookie does not exist.

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

Use the Advise method to register your VDS application's IVdsAdviseSink interface to receive notifications from VDS. Advise returns a cookie, which you must pass back as a parameter to the Unadvise method.

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.

The Unadvise method might not return immediately, because it waits for a lock to update the list of registered client applications and waits for the notification thread sending the client notifications to exit. If there are outstanding notifications to be sent to your application, the notification thread tries to send them before exiting.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Vds.h

Library

Uuid.lib

See also

IVdsService
IVdsService::Advise
IVdsAdviseSink
VDS Notifications

 

 

Community Additions

Show:
© 2014 Microsoft