VSProject.GetUniqueFilename, méthode

Article
08/10/2011

Génère un nom de fichier unique dans le projet. Utilisé pour nommer les nouveaux éléments du projet.

Espace de noms : VSLangProj
Assembly : VSLangProj (dans VSLangProj.dll)

Syntaxe

'Déclaration
Function GetUniqueFilename ( _
    pDispatch As Object, _
    bstrRoot As String, _
    bstrDesiredExt As String _
) As String

string GetUniqueFilename(
    Object pDispatch,
    string bstrRoot,
    string bstrDesiredExt
)

String^ GetUniqueFilename(
    [InAttribute] Object^ pDispatch, 
    [InAttribute] String^ bstrRoot, 
    [InAttribute] String^ bstrDesiredExt
)

abstract GetUniqueFilename : 
        pDispatch:Object * 
        bstrRoot:string * 
        bstrDesiredExt:string -> string

function GetUniqueFilename(
    pDispatch : Object, 
    bstrRoot : String, 
    bstrDesiredExt : String
) : String

Paramètres

pDispatch
Type : System.Object
Cette extension sera appliquée au nom du fichier généré.

bstrRoot
Type : System.String
Objet Project ou objet dossier ProjectItem.Le nom de fichier généré sera unique dans ce contexte.

bstrDesiredExt
Type : System.String
Le nom généré commencera par la chaîne indiquée par ce paramètre.

Valeur de retour

Type : System.String
Un nom de fichier qui est unique dans le projet ou dans le dossier du projet.Si le premier paramètre est une instance Project, alors le nom généré sera unique dans le dossier racine du projet.Le nom du fichier prend la forme Root?.Extension, où ? représente un ou plusieurs chiffres (1, 2, 3, etc.).

Notes

Cette méthode est généralement utilisée pour générer le nom d'un nouvel élément de projet.

Si vous appelez cette méthode avec KeyFile comme racine et snk comme extension, la chaîne retournée est KeyFile.snk, si le fichier KeyFile.snk n'existe pas déjà. S'il existe déjà, alors la chaîne retournée est KeyFile1.snk. Notez que si cette méthode est appelée plusieurs fois et qu'aucun fichier n'est créé à partir du nom de fichier retourné, tous les appels vont retourner la même valeur. Les résultats dépendent uniquement des fichiers existant au moment de l'appel à la méthode.

Exemples

[Visual Basic]

' This macro displays a file name that is unique in the 
' project folder, in the form root?.ext.
' Macro editor
Imports VSLangProj
Imports VSLangProj80
Sub GetUniqueName()
   Dim proj As Project
   proj = DTE.Solution.Projects.Item(1)
   Dim vsproj As VSLangProj.VSProject = _
      CType(proj.Object, VSLangProj.VSProject)
   MsgBox(vsproj.GetUniqueFilename(proj, "Root", "ext"))
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, consultez Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.

Voir aussi

Référence

VSProject Interface

VSLangProj, espace de noms

Partager via