Método IVsRunningDocumentTable.RenameDocument (String, String, IntPtr, UInt32)

Artigo
08/03/2016

Publicado: abril de 2016

Renomeia e/ou altera a posse de um documento.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (em Microsoft.VisualStudio.Shell.Interop.dll)

Sintaxe

int RenameDocument(
    string pszMkDocumentOld,
    string pszMkDocumentNew,
    IntPtr pHier,
    uint itemidNew
)

int RenameDocument(
    String^ pszMkDocumentOld,
    String^ pszMkDocumentNew,
    IntPtr pHier,
    unsigned int itemidNew
)

abstract RenameDocument : 
        pszMkDocumentOld:string *
        pszMkDocumentNew:string *
        pHier:nativeint *
        itemidNew:uint32 -> int

Function RenameDocument (
    pszMkDocumentOld As String,
    pszMkDocumentNew As String,
    pHier As IntPtr,
    itemidNew As UInteger
) As Integer

Parâmetros

pszMkDocumentOld
[in] Caminho para o documento anterior.

pszMkDocumentNew
[in] Caminho para o documento atual.

pHier
[in] O IVsHierarchy interface é se apropriar.Use HIERARCHY_DONTCHANGE se não alterar o proprietário.

itemidNew
[in] Identificador de item do documento atual se a hierarquia é se apropriar.Este é um identificador exclusivo ou pode ser um dos seguintes valores: VSITEMID_NIL, VSITEMID_ROOT, ou VSITEMID_SELECTION.Use VSITEMID_NIL se não alterar o proprietário.

Valor de retorno

Type: System.Int32

Se o método for bem-sucedido, ele retorna S_OK.Se ele falhar, ele retorna um código de erro.

Comentários

COM assinatura

De vsshell.idl:

HRESULT IVsRunningDocumentTable::RenameDocument(
   [in] LPCOLESTR     pszMkDocumentOld,
   [in] LPCOLESTR     pszMkDocumentNew,
   [in] IVsHierarchy *pHier,
   [in] VSITEMID      itemidNew
);

O projeto deve chamar este método para transferir a propriedade do documento para sua hierarquia e dar um novo documento itemid dentro do projeto.

Consulte também

Interface IVsRunningDocumentTable
Namespace Microsoft.VisualStudio.Shell.Interop

Retornar ao topo

Partilhar via