# MTEnumType

An object that holds information about an enum type (name + description) and a collection of MTEnumerator objects.

## Program ID

Metratech.MTEnumType.1

## MTEnumType Methods

Add | Adds enumerator to this enum type.
GetEnumerators | Returns enumerators defined in this enum type.
WriteSet | Internal use only.

## MTEnumType Properties

Enumspace | Initializes the underlying C++ account object.
Status | Currently not used.
EnumTypeName | Gets/sets name for this enum type.
EnumTypeDescription | Gets/sets description for this enum type.
EnumSpaceDescription | Gets/sets description for the enum space that this enum type belongs to.

## Example

Example to be provided in a future release of this online help system.

# Method Detail

## Add

Adds enumerator to this enum type.

### Visual Basic Syntax

Sub Add(pEnum As MTEnumerator)

### C++ Syntax

[id(3), helpstring("method Add")] HRESULT Add(IMTEnumerator* pEnum);

### Arguments

IMTEnumerator

Enum space description.

## GetEnumerators

Returns enumerators defined in this enum type.

### Visual Basic Syntax

Function GetEnumerators() As MTEnumeratorCollection

### C++ Syntax

[id(7), helpstring("method GetEnumerators")] HRESULT GetEnumerators([out, retval] IMTEnumeratorCollection**);

### Arguments

IMTEnumeratorCollection**

MTEnumeratorCollection object.

## WriteSet

Internal use only.

# Property Detail

## Enumspace

Initializes the underlying C++ account object.

### Visual Basic Syntax

Property Enumspace As String

### C++ Syntax

[propget, id(1), helpstring("property Enumspace")] HRESULT Enumspace([out, retval] BSTR *pVal);

### Arguments

BSTR val

Enum space name.

### Return Value

BSTR* val

Enum space name.

## Status

Currently not used.

## EnumTypeName

Gets/sets name for this enum type.

### Visual Basic Syntax

Property EnumTypeName As String

### C++ Syntax

[propget, id(2), helpstring("property EnumTypeName")] HRESULT EnumTypeName([out, retval] BSTR *pVal);

[propput, id(2), helpstring("property EnumTypeName")] HRESULT EnumTypeName([in] BSTR newVal);

### Arguments

BSTR val

Enum type name.

### Return Value

BSTR* val

Enum type name.

## EnumTypeDescription

Gets/sets description for this enum type.

### Visual Basic Syntax

Property EnumTypeDescription As String

### C++ Syntax

[propget, id(5), helpstring("property EnumTypeDescription")] HRESULT EnumTypeDescription([out, retval] BSTR *pVal);

[propput, id(5), helpstring("property EnumTypeDescription")] HRESULT EnumTypeDescription([in] BSTR newVal);

### Arguments

BSTR val

Enum type description.

### Return Value

BSTR* val

Enum type description.

## EnumSpaceDescription

Gets/sets description for enum space this enum type belongs to.

### Visual Basic Syntax

Property EnumSpaceDescription As String

### C++ Syntax

[propget, id(6), helpstring("property EnumSpaceDescription")] HRESULT EnumSpaceDescription([out, retval] BSTR *pVal);

[propput, id(6), helpstring("property EnumSpaceDescription")] HRESULT EnumSpaceDescription([in] BSTR newVal);

### Arguments

BSTR val

Enum space description.

### Return Value

BSTR* val

Enum space description.