Skip to content

Latest commit

 

History

History
109 lines (78 loc) · 5.23 KB

ne-vds-vds_controller_status.md

File metadata and controls

109 lines (78 loc) · 5.23 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
NE:vds._VDS_CONTROLLER_STATUS
VDS_CONTROLLER_STATUS (vds.h)
The VDS_CONTROLLER_STATUS (vds.h) enumeration defines the set of object status values for a controller.
*PVDS_CONTROLLER_STATUS
VDS_CONTROLLER_STATUS
VDS_CONTROLLER_STATUS enumeration [VDS]
VDS_CS_FAILED
VDS_CS_NOT_READY
VDS_CS_OFFLINE
VDS_CS_ONLINE
VDS_CS_REMOVED
VDS_CS_UNKNOWN
base.vds_controller_status
vds/VDS_CONTROLLER_STATUS
vds/VDS_CS_FAILED
vds/VDS_CS_NOT_READY
vds/VDS_CS_OFFLINE
vds/VDS_CS_ONLINE
vds/VDS_CS_REMOVED
vds/VDS_CS_UNKNOWN
vdshwprv/VDS_CONTROLLER_STATUS
vdshwprv/VDS_CS_FAILED
vdshwprv/VDS_CS_NOT_READY
vdshwprv/VDS_CS_OFFLINE
vdshwprv/VDS_CS_ONLINE
vdshwprv/VDS_CS_REMOVED
vdshwprv/VDS_CS_UNKNOWN
base\vds_controller_status.htm
base
a888fcb7-83f5-40c1-9f24-efa929aa9f6a
08/05/2022
*PVDS_CONTROLLER_STATUS, VDS_CONTROLLER_STATUS, VDS_CONTROLLER_STATUS enumeration [VDS], VDS_CS_FAILED, VDS_CS_NOT_READY, VDS_CS_OFFLINE, VDS_CS_ONLINE, VDS_CS_REMOVED, VDS_CS_UNKNOWN, base.vds_controller_status, vds/VDS_CONTROLLER_STATUS, vds/VDS_CS_FAILED, vds/VDS_CS_NOT_READY, vds/VDS_CS_OFFLINE, vds/VDS_CS_ONLINE, vds/VDS_CS_REMOVED, vds/VDS_CS_UNKNOWN, vdshwprv/VDS_CONTROLLER_STATUS, vdshwprv/VDS_CS_FAILED, vdshwprv/VDS_CS_NOT_READY, vdshwprv/VDS_CS_OFFLINE, vdshwprv/VDS_CS_ONLINE, vdshwprv/VDS_CS_REMOVED, vdshwprv/VDS_CS_UNKNOWN
vds.h
Windows
Windows Vista [desktop apps only]
Windows Server 2003 [desktop apps only]
Windows
VDS_CONTROLLER_STATUS, *PVDS_CONTROLLER_STATUS
19H1
_VDS_CONTROLLER_STATUS
vds/_VDS_CONTROLLER_STATUS
PVDS_CONTROLLER_STATUS
vds/PVDS_CONTROLLER_STATUS
VDS_CONTROLLER_STATUS
vds/VDS_CONTROLLER_STATUS
c++
APIRef
kbSyntax
HeaderDef
Vds.h
VdsHwPrv.h
VDS_CONTROLLER_STATUS

VDS_CONTROLLER_STATUS enumeration

-description

[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.

-enum-fields

-field VDS_CS_UNKNOWN:0

The status of the controller cannot be determined.

-field VDS_CS_ONLINE: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.

-field VDS_CS_NOT_READY:2

The controller is busy. The VDS_HEALTH value can be any value except VDS_H_FAILED.

-field VDS_CS_OFFLINE: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.

-field VDS_CS_FAILED:5

The controller has failed. The VDS_HEALTH value should be VDS_H_FAILED or VDS_H_FAILING.

-field VDS_CS_REMOVED: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.
 

-see-also

IVdsController::SetStatus

VDS Enumerations

VDS_CONTROLLER_PROP