VDS_CONTROLLER_STATUS enumeration (vds.h)

  • Article

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

Defines the set of object status values for a controller.

Syntax

typedef enum _VDS_CONTROLLER_STATUS {
  VDS_CS_UNKNOWN = 0,
  VDS_CS_ONLINE = 1,
  VDS_CS_NOT_READY = 2,
  VDS_CS_OFFLINE = 4,
  VDS_CS_FAILED = 5,
  VDS_CS_REMOVED = 8
} VDS_CONTROLLER_STATUS, *PVDS_CONTROLLER_STATUS;

Constants

 
VDS_CS_UNKNOWN
Value: 0
The status of the controller cannot be determined.
VDS_CS_ONLINE
Value: 1
The controller is physically present and in use. The VDS_HEALTH value associated with this controller status can be any value except VDS_H_FAILED.
VDS_CS_NOT_READY
Value: 2
The controller is busy. The VDS_HEALTH value can be any value except VDS_H_FAILED.
VDS_CS_OFFLINE
Value: 4
The controller is physically present but not available for use. For example, the controller has been set to the inactive state. When this controller status is set, a VDS_NF_CONTROLLER_REMOVED notification is sent. The VDS_HEALTH value can be any value.
VDS_CS_FAILED
Value: 5
The controller has failed. The VDS_HEALTH value should be VDS_H_FAILED or VDS_H_FAILING.
VDS_CS_REMOVED
Value: 8
The controller has been physically unplugged from the subsystem. When this status is set, a VDS_NF_CONTROLLER_DEPART notification is sent.

Windows Server 2008, Windows Vista and Windows Server 2003:  This value is not supported.

Remarks

The IVdsController::SetStatus method passes a VDS_CONTROLLER_STATUS value as an argument to set the status of a controller, and the VDS_CONTROLLER_PROP structure includes a VDS_CONTROLLER_STATUS value as a member to indicate the current status.

If your application encounters a VDS_CONTROLLER_STATUS value that it does not recognize, it should display the controller status as unknown. It should not attempt to map the unrecognized controller status to another controller status.

Note  Additional constants might be added to the VDS_CONTROLLER_STATUS enumeration in future Windows versions. For this reason, your application must be designed to gracefully handle an unrecognized VDS_CONTROLLER_STATUS enumeration constant.
 

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Header vds.h

See also

IVdsController::SetStatus

VDS Enumerations

VDS_CONTROLLER_PROP