This documentation is archived and is not being maintained.

AddEnum Method (Variation 1] (General Extensibility)

Visual Studio .NET 2003

Creates a new enumeration code construct and inserts the code in the correct location.

Note   AddEnum may not be supported by all languages. This method is not supported for Visual Basic.
[Visual Basic .NET]
Public Function AddEnum( _
   Name As String, _
   Position As Variant, _
   Bases As Variant, _
   Optional Access As vsCMAccess = vsCMAccessDefault _
) As CodeEnum
[Visual Basic 6]
Function AddEnum( _
   Name As String, _
   Position As Variant, _
   Bases As Variant, _
   Optional Access As vsCMAccess = vsCMAccessDefault _
) As CodeEnum
[C++]
HRESULT __stdcall AddEnum(
   BSTR Name,
   VARIANT Position,
   VARIANT Bases,
   vsCMAccess Access,
   /* [out, retval] */ CodeEnum** retVal
);
[C#]
CodeEnum AddEnum(
   string Name,
   object Position,
   object Bases,
   vsCMAccess Access
);
[JScript .NET]
public function AddEnum(
   Name : String,
   Position : Object,
   Bases : Object,
   Access : vsCMAccess
) : CodeEnum

Parameters

Name
Required. The name of the enum to add.
Position
Optional. Default = 0. The code element after which to add the new element. If the value is a CodeElement, then the new element is added immediately after it.

If the value is Long, then AddEnum indicates the element after which to add the new element.

Because collections begin their count at 1, passing 0 indicates that the new element should be placed at the beginning of the collection. A value of -1 means the element should be placed at the end.

Bases
Required. Default = Nothing. A variant that holds a Safe-Array of CodeType objects upon which the new enum is based on. For C#, this is the underlying type of enum.
Access
Optional. A vsCMAccess constant.

Return Value

Returns a CodeEnum object.

Remarks

The correctness of the arguments is determined by the language behind the code model.

See Also

Applies To: CodeClass Object | CodeNameSpace Object | CodeStruct Object | FileCodeModel Object | VCCodeClass Object | VCCodeIDLLibrary Object | VCCodeNamespace Object | VCCodeStruct Object | VCCodeUnion Object | VCFileCodeModel Object

Show: