VCCodeModel.AddInclude, méthode

Article
05/16/2015

Ajoute un élément #include à un fichier spécifique.

Espace de noms : Microsoft.VisualStudio.VCCodeModel
Assembly : Microsoft.VisualStudio.VCCodeModel (dans Microsoft.VisualStudio.VCCodeModel.dll)

Syntaxe

'Déclaration
Function AddInclude ( _
    Name As String, _
    Location As Object, _
    Position As Object _
) As VCCodeInclude

VCCodeInclude AddInclude(
    string Name,
    Object Location,
    Object Position
)

VCCodeInclude^ AddInclude(
    String^ Name, 
    Object^ Location, 
    Object^ Position
)

abstract AddInclude : 
        Name:string * 
        Location:Object * 
        Position:Object -> VCCodeInclude

function AddInclude(
    Name : String, 
    Location : Object, 
    Position : Object
) : VCCodeInclude

Paramètres

Name
Type : String

Requis. Indique le nom (entre guillemets ou crochets pointus) du fichier à inclure.

Location
Type : Object

Requis. Chemin d'accès ou nom du fichier à modifier. Si le fichier n'existe pas déjà, il est créé automatiquement. Le fichier est ajouté au projet s'il n'est pas déjà un élément de projet. Si vous ne pouvez pas créer et ajouter le fichier au projet, la méthode AddInclude échoue.

Position
Type : Object

Requis. Valeur par défaut = 0. Élément de code après lequel le nouvel élément doit être ajouté. Si la valeur est CodeElement, le nouvel élément est ajouté directement après.

Comme la comptabilisation des collections commence à 1, passer la valeur 0 indique que le nouvel élément doit être placé au début de la collection. La valeur -1 signifie que l'élément doit être placé à la fin.

Valeur de retour

Type : Microsoft.VisualStudio.VCCodeModel.VCCodeInclude
Objet VCCodeInclude.

Notes

Appelez cette fonction pour insérer un élément #include, directive (C/C++) dans le fichier spécifié de l'objet VCCodeModel.

Consultez Comment : compiler l'exemple de code pour l'extensibilité du modèle de code Visual C++ pour plus d'informations sur la compilation et l'exécution de cet exemple.

Exemples

Cet exemple ajoute une instruction #include au fichier de stdafx.h.

Sub AddInclude()
    Dim codeModel As VCCodeModel
    codeModel = DTE.Solution.Item(1).CodeModel
    Dim include As VCCodeInclude
    include = codeModel.AddInclude("""stdafx.h""", "File.h", 0)
End Sub

Sécurité .NET Framework

Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, voir Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.

Voir aussi

Référence

VCCodeModel Interface

Microsoft.VisualStudio.VCCodeModel, espace de noms

Partager via