DocData.IVsDocumentLockHolder.CloseDocumentHolder Method

Close the document based on a user request.

Namespace:  Microsoft.VisualStudio.Shell.Design.Serialization
Assembly:  Microsoft.VisualStudio.Shell.Design (in Microsoft.VisualStudio.Shell.Design.dll)

Syntax

'Declaration
Private Function CloseDocumentHolder ( _
    saveOptions As UInteger _
) As Integer Implements IVsDocumentLockHolder.CloseDocumentHolder

int IVsDocumentLockHolder.CloseDocumentHolder(
    uint saveOptions
)

private:
virtual int CloseDocumentHolder(
    unsigned int saveOptions
) sealed = IVsDocumentLockHolder::CloseDocumentHolder

private abstract CloseDocumentHolder : 
        saveOptions:uint32 -> int  
private override CloseDocumentHolder : 
        saveOptions:uint32 -> int

JScript does not support explicit interface implementations.

Parameters

• saveOptions
  Type: System.UInt32

  Values from the __FRAMECLOSE enumeration.

Return Value

Type: System.Int32
S_OK .

Implements

IVsDocumentLockHolder.CloseDocumentHolder(UInt32)

Remarks

After successfully closing the window frame, the owner of the frame should dispose this DocData and set it to nulla null reference (Nothing in Visual Basic), thus releasing the document lock holder as well as the lock. If DocData is not nulla null reference (Nothing in Visual Basic), dispose it in your implementation of this method.

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

See Also

Reference

DocData Class

Microsoft.VisualStudio.Shell.Design.Serialization Namespace

ShowDocumentHolder