IVsRunningDocumentTable.NotifyOnBeforeSave Method

Fires before a document in the RDT is saved.

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

Syntax

'Declaration
Function NotifyOnBeforeSave ( _
    dwCookie As UInteger _
) As Integer
int NotifyOnBeforeSave(
    uint dwCookie
)
int NotifyOnBeforeSave(
    [InAttribute] unsigned int dwCookie
)
abstract NotifyOnBeforeSave : 
        dwCookie:uint32 -> int
function NotifyOnBeforeSave(
    dwCookie : uint
) : int

Parameters

  • dwCookie
    Type: UInt32

    [in] Abstract value representing the document that is to be saved.

Return Value

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

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsRunningDocumentTable::NotifyOnBeforeSave(
   [in] VSCOOKIE dwCookie
);

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

.NET Framework Security

See Also

Reference

IVsRunningDocumentTable Interface

Microsoft.VisualStudio.Shell.Interop Namespace