IVsPersistDocData.OnRegisterDocData(UInt32, IVsHierarchy, UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Called by the Running Document Table (RDT) when it registers the document data in the RDT.

public:
 int OnRegisterDocData(System::UInt32 docCookie, Microsoft::VisualStudio::Shell::Interop::IVsHierarchy ^ pHierNew, System::UInt32 itemidNew);

public:
 int OnRegisterDocData(unsigned int docCookie, Microsoft::VisualStudio::Shell::Interop::IVsHierarchy ^ pHierNew, unsigned int itemidNew);

int OnRegisterDocData(unsigned int docCookie, Microsoft::VisualStudio::Shell::Interop::IVsHierarchy const & pHierNew, unsigned int itemidNew);

public int OnRegisterDocData (uint docCookie, Microsoft.VisualStudio.Shell.Interop.IVsHierarchy pHierNew, uint itemidNew);

abstract member OnRegisterDocData : uint32 * Microsoft.VisualStudio.Shell.Interop.IVsHierarchy * uint32 -> int

Public Function OnRegisterDocData (docCookie As UInteger, pHierNew As IVsHierarchy, itemidNew As UInteger) As Integer

Parameters

docCookie: UInt32

[in] Abstract handle for the document to be registered. See the VSDOCCOOKIE datatype.

pHierNew: IVsHierarchy

[in] Pointer to the IVsHierarchy interface.

itemidNew: UInt32

[in] Item identifier of the document to be registered from VSITEM.

Returns

Int32

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

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsPersistDocData::OnRegisterDocData(  
   [in] VSCOOKIE docCookie,  
   [in] IVsHierarchy *pHierNew,  
   [in] VSITEMID itemidNew  
);

Applies to