VSProject.GetUniqueFilename - метод

Статья
05/17/2015

Создает уникальное имя файла в проекте. Используется для именования новых элементов проекта.

Пространство имен: VSLangProj
Сборка: VSLangProj (в VSLangProj.dll)

Синтаксис

'Декларация
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

Параметры

pDispatch
Тип: Object

Это значение будет расширением созданного имени.

bstrRoot
Тип: String

Объект Project или объект папки ProjectItem. Созданное имя файла будет уникально в этом контексте.

bstrDesiredExt
Тип: String

Созданное имя будет начинаться с этой строки.

Возвращаемое значение

Тип: String
Имя файла, уникальное в пределах проекта или папки проекта.Если первый параметр является экземпляром Project, созданное имя будет уникально в пределах корневой папки проекта.Имя файла будет иметь формат корень?.расширение, где ? — одна или несколько цифр (1, 2, 3 и т. д.).

Заметки

Обычно данный метод используется для создания имени нового элемента проекта.

При вызове этого метода с корнем KeyFile и расширением SNK возвращается строка KeyFile.snk, если файл KeyFile.snk еще не существует. Если файл KeyFile.snk уже существует, возвращается строка KeyFile1.snk. Следует помнить, что если этот метод вызывается несколько раз, а файл с возвращенным именем не создается, при каждом вызове будет возвращаться одно и то же значение. Результаты зависят только от файлов, существующих во время вызова данного метода.

Примеры

[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

Безопасность платформы .NET Framework

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Для получения дополнительной информации см. Использование библиотек из не вполне надежного кода.

См. также

Ссылки

VSProject Интерфейс

VSLangProj - пространство имен

Поделиться через