nf-vds-ivdsservice-unadvise.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:vds.IVdsService.Unadvise	IVdsService::Unadvise (vds.h)	Unregisters the caller's IVdsAdviseSink interface so that the caller no longer receives notifications from the VDS service.	IVdsService interface [VDS] Unadvise method IVdsService.Unadvise IVdsService::Unadvise Unadvise Unadvise method [VDS] Unadvise method [VDS] IVdsService interface base.ivdsservice_unadvise vds/IVdsService::Unadvise	base\ivdsservice_unadvise.htm	base	085d380c-2e09-470a-a23d-704c31535975	12/05/2018	IVdsService interface [VDS],Unadvise method, IVdsService.Unadvise, IVdsService::Unadvise, Unadvise, Unadvise method [VDS], Unadvise method [VDS],IVdsService interface, base.ivdsservice_unadvise, vds/IVdsService::Unadvise	vds.h		Windows	Windows Vista [desktop apps only]	Windows Server 2003 [desktop apps only]										Uuid.lib			Windows			19H1	IVdsService::Unadvise vds/IVdsService::Unadvise	c++	APIRef kbSyntax	COM	Uuid.lib Uuid.dll	IVdsService.Unadvise

IVdsService::Unadvise

-description

[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.

-parameters

-param dwCookie [in]

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

-returns

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 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.

-see-also

IVdsAdviseSink

IVdsService

IVdsService::Advise

VDS Notifications