Skip to content

Latest commit

 

History

History
181 lines (142 loc) · 5.75 KB

nf-vds-ivdscontroller-setstatus.md

File metadata and controls

181 lines (142 loc) · 5.75 KB
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.IVdsController.SetStatus
IVdsController::SetStatus (vds.h)
The IVdsController::SetStatus (vds.h) method sets the status of a controller to the specified value.
IVdsController interface [VDS]
SetStatus method
IVdsController.SetStatus
IVdsController::SetStatus
SetStatus
SetStatus method [VDS]
SetStatus method [VDS]
IVdsController interface
base.ivdscontroller_setstatus
vds/IVdsController::SetStatus
vdshwprv/IVdsController::SetStatus
base\ivdscontroller_setstatus.htm
base
f9bae451-ef47-46ad-a11e-b7b36a031a8a
08/05/2022
IVdsController interface [VDS],SetStatus method, IVdsController.SetStatus, IVdsController::SetStatus, SetStatus, SetStatus method [VDS], SetStatus method [VDS],IVdsController interface, base.ivdscontroller_setstatus, vds/IVdsController::SetStatus, vdshwprv/IVdsController::SetStatus
vds.h
Windows
Windows Vista [desktop apps only]
Windows Server 2003 [desktop apps only]
Uuid.lib
Windows
19H1
IVdsController::SetStatus
vds/IVdsController::SetStatus
c++
APIRef
kbSyntax
COM
Uuid.lib
Uuid.dll
IVdsController.SetStatus

IVdsController::SetStatus

-description

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

Sets the status of a controller to the specified value.

-parameters

-param status [in]

Values enumerated by VDS_CONTROLLER_STATUS. Callers can pass in a subset of the possible enumeration values. Passing in VDS_CS_UNKNOWN returns E_INVALIDARG.

-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
VDS_E_PROVIDER_CACHE_CORRUPT
0x8004241FL
This return value signals a software or communication problem inside a provider that caches information about the array. Use the IVdsHwProvider::Reenumerate method followed by the IVdsHwProvider::Refresh method to restore the cache.
VDS_E_OBJECT_DELETED
0x8004240BL
The controller object is no longer present.
VDS_E_OBJECT_STATUS_FAILED
0x80042431L
The controller is in a failed state and is unable to perform the requested operation.
VDS_E_ANOTHER_CALL_IN_PROGRESS
0x80042404L
Another operation is in progress; this operation cannot proceed until the previous operation or operations are complete.
VDS_E_NOT_SUPPORTED
0x80042400L
This operation or combination of parameters is not supported by this provider.

-remarks

This method enables you to set the status of a single controller. You can set the status of all the controllers in a subsystem at once by calling the IVdsSubSystem::SetControllerStatus method. Use the IVdsController::GetProperties method to get the current status of the controller.

Implementers are responsible for performing any necessary operations to get the status to the specified state. For example, if the caller passes in VDS_CS_OFFLINE as the controller status, you might need to first clear the cache for the controller.

-see-also

IVdsController

IVdsController::GetProperties

IVdsHwProvider::Reenumerate

IVdsHwProvider::Refresh

IVdsSubSystem::SetControllerStatus

VDS_CONTROLLER_STATUS