CodeClass::AddEnum Method (String^, Object^, Object^, vsCMAccess)

 

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

Namespace:   EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

CodeEnum^ AddEnum(
	String^ Name,
	Object^ Position,
	Object^ Bases,
	vsCMAccess Access = vsCMAccess::vsCMAccessDefault
)

Parameters

Name
Type: System::String^

Required. The name of the enum to add.

Position
Type: System::Object^

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 a 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
Type: System::Object^

Optional. Default = Nothing. A variant that holds a SafeArray of fully qualified type names or CodeType objects that specify the underlying type of the new enum.

Access
Type: EnvDTE::vsCMAccess

Optional. A vsCMAccess constant.

Return Value

Type: EnvDTE::CodeEnum^

A CodeEnum object.

The correctness of the arguments is determined by the language behind the code model. All languages ignore the Bases parameter.

System_CAPS_noteNote

The values of code model elements such as classes, structs, functions, attributes, delegates, and so forth can be non-deterministic after making certain kinds of edits, meaning that their values cannot be relied upon to always remain the same. For more information, see the section Code Model Element Values Can Change in Discovering Code by Using the Code Model (Visual Basic).

Return to top
Show: