Share via


IVsDocumentLockHolder.CloseDocumentHolder Method

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)

Syntax

'Declaration
Function CloseDocumentHolder ( _
    dwSaveOptions As UInteger _
) As Integer
int CloseDocumentHolder(
    uint dwSaveOptions
)
int CloseDocumentHolder(
    unsigned int dwSaveOptions
)
abstract CloseDocumentHolder : 
        dwSaveOptions:uint32 -> int
function CloseDocumentHolder(
    dwSaveOptions : uint
) : int

Parameters

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 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.

.NET Framework Security

See Also

Reference

IVsDocumentLockHolder Interface

Microsoft.VisualStudio.Shell.Interop Namespace