Export (0) Print
Expand All
Cut
Run
Expand Minimize
This topic has not yet been rated - Rate this topic

AddStruct Method [Variation 1] (General Extensibility)

Visual Studio .NET 2003

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

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

Parameters

Name
Required. The name of the new structure.
Location
Required. The path and filename for the new structure definition. Depending on the language, the filename 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
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 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. A variant that holds a Safe-Array of CodeInterface objects from which the new interface derives.
ImplementedInterfaces
Required. Default value is Nothing. A Safe-Array of CodeInterfaces representing interfaces that the new class promises to implement.
Access
Optional. A vsCMAccess constant.

Return Value

Returns a CodeStruct object.

Remarks

All languages support a period-separated format for the fully qualified type name, but some languages also support another particular format, such as a colon-separated (::) elements for Visual C++ .NET.

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

See Also

Applies To: CodeModel Object | VCCodeModel Object

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.