IVdsDisk2::SetSANMode method (vds.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.]

Sets the SAN mode of a disk to offline or online.

Note Starting with Windows Vista with Service Pack 1 (SP1), this method is superseded by the IVdsDiskOnline::Online and IVdsDiskOnline::Offline methods.

Syntax

HRESULT SetSANMode(
  [in] BOOL bEnable
);

Parameters

[in] bEnable

Specify TRUE for online or FALSE for offline.

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 SAN mode was set successfully.
VDS_E_FAILED_TO_OFFLINE_DISK 0x80042597L	The offline operation failed.
VDS_E_FAILED_TO_ONLINE_DISK 0x80042596L	The online operation failed.

Remarks

Setting the SAN mode of a disk to offline is called "offlining" the disk. Setting it to online is called "onlining" the disk.

Windows Vista: Setting the SAN mode of a disk to offline also makes the disk read-only. Setting it to online also makes the disk read-write.

Requirements

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