IVsRunningDocumentTable.RegisterDocumentLockHolder Method

Definition

Registers a document lock holder in the running document table.

public:
 int RegisterDocumentLockHolder(System::UInt32 grfRDLH, System::UInt32 dwCookie, Microsoft::VisualStudio::Shell::Interop::IVsDocumentLockHolder ^ pLockHolder, [Runtime::InteropServices::Out] System::UInt32 % pdwLHCookie);
int RegisterDocumentLockHolder(unsigned int grfRDLH, unsigned int dwCookie, Microsoft::VisualStudio::Shell::Interop::IVsDocumentLockHolder const & pLockHolder, [Runtime::InteropServices::Out] unsigned int & pdwLHCookie);
public int RegisterDocumentLockHolder (uint grfRDLH, uint dwCookie, Microsoft.VisualStudio.Shell.Interop.IVsDocumentLockHolder pLockHolder, out uint pdwLHCookie);
abstract member RegisterDocumentLockHolder : uint32 * uint32 * Microsoft.VisualStudio.Shell.Interop.IVsDocumentLockHolder * uint32 -> int
Public Function RegisterDocumentLockHolder (grfRDLH As UInteger, dwCookie As UInteger, pLockHolder As IVsDocumentLockHolder, ByRef pdwLHCookie As UInteger) As Integer

Parameters

grfRDLH
UInt32

[in] This is zero or a flag taken from the __VSREGDOCLOCKHOLDER enumeration.

dwCookie
UInt32

[in] Abstract value representing the open document for which the read or edit lock is to be released.

pLockHolder
IVsDocumentLockHolder

[in] An IVsDocumentLockHolder interface representing the document lock holder for the registered document.

pdwLHCookie
UInt32

[out] Unique value representing the document lock holder.

Returns

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

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsRunningDocumentTable::RegisterDocumentLockHolder(  
   [in] VSREGDOCLOCKHOLDER     grfRDLH,  
   [in] VSCOOKIE               dwCookie,  
   [in] IVsDocumentLockHolder *pLockHolder,  
   [out] VSCOOKIE             *pdwLHCookie  
);  

Use this identifier returned in the pdwLHCookie parameter to unregister the document lock holder by calling the UnregisterDocumentLockHolder method.

The dwCookie parameter is same value that is returned from the FindAndLockDocument or RegisterAndLockDocument methods.

Applies to