IVdsProviderPrivate::OnUnload method (vdshwprv.h)
Prompts the provider object to uninitialize itself.
HRESULT OnUnload( [in] BOOL bForceUnload );
If true, VDS attempts to forcibly unload the provider. If false, VDS makes no such attempt.
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.
||The provider is unloaded.|
||The provider is unable to unload at this time. VDS tries again later.|
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.
|Minimum supported client||Windows Vista [desktop apps only]|
|Minimum supported server||Windows Server 2003 [desktop apps only]|