IVdsProviderPrivate::OnLoad 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 to initialize itself, and passes a callback object that the provider uses to get necessary interfaces.

Syntax

HRESULT OnLoad(
  [in] LPWSTR   pwszMachineName,
  [in] IUnknown *pCallbackObject
);

Parameters

[in] pwszMachineName

This parameter is reserved.

[in] pCallbackObject

Pointer to a callback object.

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 provider is initialized.
VDS_E_INITIALIZED_FAILED 0x80042401L	The provider failed to initialize.

Remarks

VDS calls this method immediately after calling the CoCreateInstance method on a provider.

Implementers must implement this method. Invoke the IUnknown::QueryInterface method to query for the IVdsAdviseSink interface.

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