2.2.3.4 ENUM_ENTRY

The ENUM_ENTRY structure contains information about a single element in an ENUM_LIST, as specified in section 2.2.3.5. An ENUM_ENTRY contains the name of a cluster object.

 typedef struct _ENUM_ENTRY {
   DWORD Type;
   [string] LPWSTR Name;
 } ENUM_ENTRY,
  *PENUM_ENTRY;

Type: Specifies the type of the object that is represented by the list element. This member MUST be set to one of the following values.

If the ENUM_LIST is returned by a call to ApiCreateEnum (section 3.1.4.2.8) or ApiCreateEnumEx (section 3.1.4.2.124), Type is set to one of the following values.

Value

Meaning

CLUSTER_ENUM_NODE

0x00000001

If returned by ApiCreateEnum, this ENUM_ENTRY list element contains the name of a cluster node. If returned by ApiCreateEnumEx, this ENUM_ENTRY list element contains the name or ID, as specified in section 3.1.4.2.124, of a cluster node.

CLUSTER_ENUM_RESTYPE

0x00000002

If returned by ApiCreateEnum, this ENUM_ENTRY list element contains the name of a cluster resource type. If returned by ApiCreateEnumEx, this ENUM_ENTRY list element contains the name or ID, as specified in section 3.1.4.2.124, of a cluster resource type.

CLUSTER_ENUM_RESOURCE

0x00000004

If returned by ApiCreateEnum, this ENUM_ENTRY list element contains the name of a cluster resource. If returned by ApiCreateEnumEx, this ENUM_ENTRY list element contains the name or ID, as specified in section 3.1.4.2.124, of a cluster resource.

CLUSTER_ENUM_GROUP

0x00000008

If returned by ApiCreateEnum, this ENUM_ENTRY list element contains the name of a cluster group. If returned by ApiCreateEnumEx, this ENUM_ENTRY list element contains the name or ID, as specified in section 3.1.4.2.124, of a cluster group.

CLUSTER_ENUM_NETWORK

0x00000010

If returned by ApiCreateEnum, this ENUM_ENTRY list element contains the name of a cluster network. If returned by ApiCreateEnumEx, this ENUM_ENTRY list element contains the name or ID, as specified in section 3.1.4.2.124, of a cluster network.

CLUSTER_ENUM_NETINTERFACE

0x00000020

If returned by ApiCreateEnum, this ENUM_ENTRY list element contains the name of a cluster network interface. If returned by ApiCreateEnumEx, this ENUM_ENTRY list element contains the name or ID, as specified in section 3.1.4.2.124, of a cluster network interface.

CLUSTER_ENUM_SHARED_VOLUME_RESOURCE

0x40000000

If returned by ApiCreateEnum, this ENUM_ENTRY list element contains the name of a cluster shared volume. If returned by ApiCreateEnumEx, this ENUM_ENTRY list element contains the name or ID, as specified in section 3.1.4.2.124, of a cluster shared volume.

CLUSTER_ENUM_INTERNAL_NETWORK

0x80000000

If returned by ApiCreateEnum, this ENUM_ENTRY list element contains the name of a cluster network used only for internal cluster communications. If returned by ApiCreateEnumEx, this ENUM_ENTRY list element contains the name or ID, as specified in section 3.1.4.2.124, of a cluster network used only for internal cluster communications.

If the ENUM_LIST is returned by a call to ApiCreateResEnum, as specified in section 3.1.4.2.23, Type is set to one of the following values.

Value

Meaning

CLUSTER_RESOURCE_ENUM_DEPENDS

0x00000001

This ENUM_ENTRY list element contains the name of a cluster resource that is depended upon, as described in Section 3.1.1.1.1 by the resource designated in the call to ApiCreateResEnum.

CLUSTER_RESOURCE_ENUM_PROVIDES

0x00000002

This ENUM_ENTRY list element contains the name of a cluster resource that depends upon, as described in Section 3.1.1.1.1 by the resource designated in the call to ApiCreateResEnum.

CLUSTER_RESOURCE_ENUM_NODES

0x00000004

This ENUM_ENTRY list element contains the name of a cluster node that can host the resource designated in the call to ApiCreateResEnum.

If the ENUM_LIST is returned by a call to ApiCreateGroupResourceEnum, as specified in section 3.1.4.2.54, Type is set to one of the following values.

Value

Meaning

CLUSTER_GROUP_ENUM_CONTAINS

0x00000001

This ENUM_ENTRY list element contains the name of a cluster resource that is contained in the group designated in the call to ApiCreateGroupResourceEnum.

CLUSTER_GROUP_ENUM_NODES

0x00000002

This ENUM_ENTRY list element contains the name of a cluster node that can host the group designated in the call to ApiCreateGroupResourceEnum.

If the ENUM_LIST is returned by a call to ApiCreateNetworkEnum, as specified in section 3.1.4.2.85, Type is set to one of the following values.

Value

Meaning

CLUSTER_NETWORK_ENUM_NETINTERFACES

0x00000001

This ENUM_ENTRY list element contains the name of a cluster network interface.

If the ENUM_LIST is returned by a call to ApiCreateNodeEnum (section 3.1.4.2.101) or ApiCreateNodeEnumEx (section 3.1.4.2.123), Type is set to one of the following values.

Value

Meaning

CLUSTER_NODE_ENUM_NETINTERFACES

0x00000001

This ENUM_ENTRY list element contains the name of a cluster network interface.

CLUSTER_NODE_ENUM_GROUPS

0x00000002

If returned by ApiCreateNodeEnum, this ENUM_ENTRY list element contains the name of a cluster group. If returned by ApiCreateNodeEnumEx, this ENUM_ENTRY list element contains the name or ID, as specified in section 3.1.4.2.123, of a cluster group.

If the ENUM_LIST is returned by a call to ApiCreateResTypeEnum, as specified in section 3.1.4.2.103, Type is set to one of the following values.

Value

Meaning

CLUSTER_RESOURCE_TYPE_ENUM_NODES

0x00000001

This ENUM_ENTRY list element contains the name of a cluster node.

CLUSTER_RESOURCE_TYPE_ENUM_RESOURCES

0x00000002

This ENUM_ENTRY list element contains the name of a cluster resource.

If the ENUM_LIST is returned by a call to ApiCreateNetInterfaceEnum, as specified in section 3.1.4.2.163, Type is set to one of the following values.

Value

Meaning

CLUSTER_ENUM_NETINTERFACE

0x00000020

If returned by ApiCreateNetInterfaceEnum, this ENUM_ENTRY list element contains the list of cluster network interfaces.

Name: If the ENUM_LIST is returned by a call to ApiCreateNodeEnumEx (section 3.1.4.2.123), it contains the return data specified in section 3.1.4.2.123.

If the ENUM_LIST is returned by a call to ApiCreateEnumEx (section 3.1.4.2.124), it contains the return data specified in section 3.1.4.2.124.

Otherwise, a null-terminated Unicode string that specifies the name of the object that is represented by the list element. See section 3.1.4 for information about the maximum length of this string.

Show: