Export (0) Print
Expand All

VCCodeModel.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,
	Object Location,
	Object Position,
	Object Bases,
	Object ImplementedInterfaces,
	vsCMAccess Access
)

Parameters

Name
Type: System.String

Required. The name of the new structure.

Location
Type: System.Object

Required. The path and file name for the new structure definition. Depending on the language, the file name is either relative or absolute to the project file. The file is added to the project if it is not already a project item. If the file cannot be created and added to the project, then AddStruct fails.

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

Required. Default value is Nothing or null. A variant that holds a SafeArray of fully qualified type names or CodeInterface objects from which the new interface derives.

ImplementedInterfaces
Type: System.Object

Required. Default value is Nothing or null. A SafeArray of fully qualified type names or CodeInterfaces representing interfaces that the new class promises to implement.

Access
Type: EnvDTE.vsCMAccess

Optional. A vsCMAccess constant.

Return Value

Type: EnvDTE.CodeStruct
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:
© 2015 Microsoft