VSProject.GetUniqueFilename メソッド

更新 : 2007 年 11 月

プロジェクト内で一意のファイル名を生成します。新しいプロジェクト項目に名前を付けるために使用します。

名前空間 : VSLangProj
アセンブリ : VSLangProj (VSLangProj.dll 内)

構文

'宣言
Function GetUniqueFilename ( _
    pDispatch As Object, _
    bstrRoot As String, _
    bstrDesiredExt As String _
) As String
'使用
Dim instance As VSProject
Dim pDispatch As Object
Dim bstrRoot As String
Dim bstrDesiredExt As String
Dim returnValue As String

returnValue = instance.GetUniqueFilename(pDispatch, _
    bstrRoot, bstrDesiredExt)

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

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

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

パラメータ

pDispatch
型 : System.Object

生成されるファイル名の拡張子になります。

bstrRoot
型 : System.String

Project オブジェクトまたはフォルダの ProjectItem オブジェクト。生成されるファイル名は、このコンテキスト内で一意になります。

bstrDesiredExt
型 : System.String

生成される名前は、この文字列で始まります。

戻り値

型 : System.String

プロジェクトまたはプロジェクトフォルダで一意のファイル名を返します。最初のパラメータが Project インスタンスの場合、生成される名前はルートプロジェクトフォルダ内で一意になります。ファイル名は Root?.Extension の形式です。? には、1、2、3 などの 1 つ以上の数字が入ります。

解説

このメソッドは一般的に、新しいプロジェクト項目の名前を生成するときに使用します。

Root に KeyFile、Extension に snk を指定してこのメソッドを呼び出したときに、KeyFile.snk というファイルが存在しない場合は KeyFile.snk という文字列が返されます。KeyFile.snk というファイルが既に存在する場合は、KeyFile1.snk が返されます。このメソッドを複数回呼び出しても返されたファイル名のファイルが作成されない場合は、すべての呼び出しで同じ値が返されます。結果は、メソッドの呼び出し時に存在するファイルによって決まります。

例

' 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