IVsPersistDocData2::RenameDocData Method (UInt32, IVsHierarchy^, UInt32, String^)

Visual Studio 2015

Renames the document data.

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

Syntax

C++

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

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:

C++

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.