IVsDocumentLockHolder::CloseDocumentHolder Method (UInt32)

 

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

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

int CloseDocumentHolder(
	unsigned int dwSaveOptions
)

Parameters

dwSaveOptions
Type: System::UInt32

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

Return Value

Type: System::Int32

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

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.

Return to top
Show: