IVsPersistDocData2.RenameDocData Method

Artikel
12/17/2007

Renames the document data.

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

Syntax

'Declaration
Function RenameDocData ( _
    grfAttribs As UInteger, _
    pHierNew As IVsHierarchy, _
    itemidNew As UInteger, _
    pszMkDocumentNew As String _
) As Integer
'Usage
Dim instance As IVsPersistDocData2
Dim grfAttribs As UInteger
Dim pHierNew As IVsHierarchy
Dim itemidNew As UInteger
Dim pszMkDocumentNew As String
Dim returnValue As Integer

returnValue = instance.RenameDocData(grfAttribs, _
    pHierNew, itemidNew, pszMkDocumentNew)

int RenameDocData(
    uint grfAttribs,
    IVsHierarchy pHierNew,
    uint itemidNew,
    string pszMkDocumentNew
)

int RenameDocData(
    [InAttribute] unsigned int grfAttribs, 
    [InAttribute] IVsHierarchy^ pHierNew, 
    [InAttribute] unsigned int itemidNew, 
    [InAttribute] String^ pszMkDocumentNew
)

function RenameDocData(
    grfAttribs : uint, 
    pHierNew : IVsHierarchy, 
    itemidNew : uint, 
    pszMkDocumentNew : String
) : int

Parameters

grfAttribs
Type: System.UInt32

[in] File attribute of the document data to be renamed. See the data type __VSRDTATTRIB.

pHierNew
Type: Microsoft.VisualStudio.Shell.Interop.IVsHierarchy

[in] Pointer to the IVsHierarchy interface of the document being renamed.

itemidNew
Type: System.UInt32

[in] Item identifier of the document being renamed. See the data type VSITEMID.

pszMkDocumentNew
Type: System.String

[in] Path to the document being renamed.

Return Value

Type: System.Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Implements

IVsPersistDocData.RenameDocData(UInt32, IVsHierarchy, UInt32, String)

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsPersistDocData2::RenameDocData(
   [in] VSRDTATTRIB grfAttribs,
   [in] IVsHierarchy *pHierNew,
   [in] VSITEMID itemidNew,
   [in] LPCOLESTR pszMkDocumentNew
);

This method can also transfer ownership of the document data from one hierarchy to another.

Permissions

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Freigeben über