IVdsProviderPrivate::OnUnload method (vdshwprv.h)

Article
02/22/2024

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

Prompts the provider object to uninitialize itself.

Syntax

HRESULT OnUnload(
  [in] BOOL bForceUnload
);

Parameters

[in] bForceUnload

If true, VDS attempts to forcibly unload the provider. If false, VDS makes no such attempt.

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	Description
S_OK	The provider is unloaded.
S_FALSE	The provider is unable to unload at this time. VDS tries again later.

Remarks

VDS calls this method immediately before releasing the reference to the provider object. When the reference count drops to zero, the provider unloads. If the OnLoad method fails, VDS does not call OnUnload.

Notes to implementers: You must perform all necessary clean up, even without the call to OnUnload.

Requirements

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