IVsPersistDocData.OnRegisterDocData Method

Article
07/12/2014

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

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

Syntax

'Declaration
Function OnRegisterDocData ( _
    docCookie As UInteger, _
    pHierNew As IVsHierarchy, _
    itemidNew As UInteger _
) As Integer

int OnRegisterDocData(
    uint docCookie,
    IVsHierarchy pHierNew,
    uint itemidNew
)

int OnRegisterDocData(
    [InAttribute] unsigned int docCookie, 
    [InAttribute] IVsHierarchy^ pHierNew, 
    [InAttribute] unsigned int itemidNew
)

abstract OnRegisterDocData : 
        docCookie:uint32 * 
        pHierNew:IVsHierarchy * 
        itemidNew:uint32 -> int

function OnRegisterDocData(
    docCookie : uint, 
    pHierNew : IVsHierarchy, 
    itemidNew : uint
) : int

Parameters

docCookie
Type: System.UInt32

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

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

[in] Pointer to the IVsHierarchy interface.

itemidNew
Type: System.UInt32

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

Return Value

Type: System.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
);

.NET Framework Security

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.