Share via


IVsDocumentLockHolder.CloseDocumentHolder(UInt32) Method

Definition

Called when the environment closes a document with an IVsDocumentLockHolder entry in the running document table.

public:
 int CloseDocumentHolder(System::UInt32 dwSaveOptions);
public:
 int CloseDocumentHolder(unsigned int dwSaveOptions);
int CloseDocumentHolder(unsigned int dwSaveOptions);
public int CloseDocumentHolder (uint dwSaveOptions);
abstract member CloseDocumentHolder : uint32 -> int
Public Function CloseDocumentHolder (dwSaveOptions As UInteger) As Integer

Parameters

dwSaveOptions
UInt32

[in] Save options for the document. For more information, see __FRAMECLOSE.

Returns

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

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsDocumentLockHolder::CloseDocumentHolder(  
   FRAMECLOSE dwSaveOptions  
);  

IVsDocumentLockHolder::CloseDocumentHolder is called by the environment when the following occurs:

  • The document is closed in the environment

  • The document is going to be opened by an editor managed by the environment and the environment needs to close the invisible lock holder first.

Applies to