This documentation is archived and is not being maintained.

VCCodeNamespace.AddStruct Method 

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

Namespace: Microsoft.VisualStudio.VCCodeModel
Assembly: Microsoft.VisualStudio.VCCodeModel (in microsoft.visualstudio.vccodemodel.dll)

CodeStruct AddStruct (
	string Name,
	[OptionalAttribute] Object Position,
	[OptionalAttribute] Object Bases,
	[OptionalAttribute] Object ImplementedInterfaces,
	[OptionalAttribute] vsCMAccess Access
)
CodeStruct AddStruct (
	String Name, 
	/** @attribute OptionalAttribute() */ Object Position, 
	/** @attribute OptionalAttribute() */ Object Bases, 
	/** @attribute OptionalAttribute() */ Object ImplementedInterfaces, 
	/** @attribute OptionalAttribute() */ vsCMAccess Access
)
function AddStruct (
	Name : String, 
	Position : Object, 
	Bases : Object, 
	ImplementedInterfaces : Object, 
	Access : vsCMAccess
) : CodeStruct

Parameters

Name

Required. The name of the new structure.

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 a Long data type, then AddStruct 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 value is Nothing or a null reference (Nothing in Visual Basic). A variant that holds a SafeArray of fully qualified type names or CodeInterface objects from which the new interface derives.

ImplementedInterfaces

Required. Default value is Nothing or a null reference (Nothing in Visual Basic). A SafeArray of fully qualified type names or CodeInterface objects, each representing interfaces that the new class promises to implement.

Access

Optional. A vsCMAccess constant.

Return Value

A CodeStruct object.

Visual C++ requires the colon-separated (::) format for its fully qualified type names. All other languages support the period-separated format.

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

Show: