IVdsController::SetStatus method (vds.h)
[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.
Syntax
HRESULT SetStatus(
[in] VDS_CONTROLLER_STATUS status
);
Parameters
[in] status
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.
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 |
|---|---|
|
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. |
|
The controller object is no longer present. |
|
The controller is in a failed state and is unable to perform the requested operation. |
|
Another operation is in progress; this operation cannot proceed until the previous operation or operations are complete. |
|
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.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Target Platform | Windows |
| Header | vds.h |
| Library | Uuid.lib |