Enumerated Types Overview

Enumerated Types Overview

Enumerated Types Overview

An enumerated type (or enumeration) stores a specific set of pre-defined values. Enumerated data types serve the same purpose as constants. For example, the VslmTaskInfoState enumerated type contains four constants to convey the possible states of a task:

  • error
  • queued
  • running
  • success

Enumeration values can be passed to, or returned by, the operations of a managed object. Properties of managed objects or data objects can also be defined using enumerated types.

All enumerations are listed in the pane on lower left. Click a name to read about the enumeration. Reference documentation for enumerated types includes:

  • Description of purpose and usage
  • A list of valid enum constant values

The list to the left is a simple alphabetic list of all enumerated types.

To read about a specific enumeration, start typing its name in Quick Index and click.