Windows desktop applications
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

VDS_PORT_STATUS enumeration

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

Syntax


typedef enum  { 
  VDS_PRS_UNKNOWN    = 0,
  VDS_PRS_ONLINE     = 1,
  VDS_PRS_NOT_READY  = 2,
  VDS_PRS_OFFLINE    = 4,
  VDS_PRS_FAILED     = 5,
  VDS_PRS_REMOVED    = 8
} VDS_PORT_STATUS;

Constants

VDS_PRS_UNKNOWN

The status of the port cannot be determined.

VDS_PRS_ONLINE

The port is physically present and in use. The VDS_HEALTH value associated with this port status can be any value except VDS_H_FAILED.

VDS_PRS_NOT_READY

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

VDS_PRS_OFFLINE

Either the port or its controller is physically present but not available for use. For example, the port or its controller has been set to the inactive state. When this status is set, a VDS_NF_PORT_REMOVED notification is sent. The VDS_HEALTH value can be any value.

VDS_PRS_FAILED

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

VDS_PRS_REMOVED

The port's controller has been physically removed from the subsystem. When this status is set, a VDS_NF_PORT_DEPART notification is sent.

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

Remarks

The VDS_PORT_PROP structure includes a VDS_PORT_STATUS value as a member to indicate the current status of a port.

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

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

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Vds.h;
VdsHwPrv.h (for hardware providers)

See also

VDS Enumerations
VDS_PORT_PROP

 

 

Community Additions

Show:
© 2016 Microsoft