IVsRunningDocumentTable.NotifyOnBeforeSave(UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Fires before a document in the RDT is saved.

public:
 int NotifyOnBeforeSave(System::UInt32 dwCookie);

public:
 int NotifyOnBeforeSave(unsigned int dwCookie);

int NotifyOnBeforeSave(unsigned int dwCookie);

public int NotifyOnBeforeSave (uint dwCookie);

abstract member NotifyOnBeforeSave : uint32 -> int

Public Function NotifyOnBeforeSave (dwCookie As UInteger) As Integer

Parameters

dwCookie: UInt32

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

Returns

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.

Applies to