IPersistFile::Save

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method saves a copy of the object into the specified file.

Syntax

HRESULT Save(
  LPCOLESTR pszFileName,
  BOOL fRemember 
);

Parameters

• pszFileName
  [in] Points to a zero-terminated string containing the absolute path of the file to which the object should be saved. If pszFileName is NULL, the object should save its data to the current file, if there is one.

• fRemember
  [in] Indicates whether the pszFileName parameter is to be used as the current working file.

  If TRUE, pszFileName becomes the current file and the object should clear its dirty flag after the save.

  If FALSE, this save operation is a Save A Copy As ... operation. In this case, the current file is unchanged and the object should not clear its dirty flag.

  If pszFileName is NULL, the implementation should ignore the fRemember flag.

Return Value

• S_OK
  The object was successfully saved.

• E_FAIL
  The file was not saved.

IPersistFile::Save STG_E_* errors.

Remarks

This method can be called to save an object to the specified file in one of three ways:

• Save. Call IPersistFile::GetCurFile first to determine whether the object has an associated file name. If so, call IPersistFile::Save specifying NULL for the pszFileName parameter in this method to indicate that the object should be saved to its current file. Then call IPersistFile::SaveCompleted to indicate completion.
• Save As. Call IPersistFile::Save specifying TRUE in the fRemember parameter and a non-NULL value, indicating the name of the new file the object is to be saved to, for the pszFileName parameter . Then call IPersistFile::SaveCompleted to indicate completion.
• Save a Copy As. Call IPersistFile::Save specifying FALSE in the fRemember parameter and a non-NULL value, indicating the name of the new file the object is to be copied to, for the pszFileName parameter.

The implementer must detect which type of save operation the caller is requesting.

If the pszFileName parameter is NULL, a Save is being requested.

If the pszFileName parameter is not NULL, use the value of the fRemember parameter to distinguish between a Save As and a Save a Copy As.

In Save or Save As operations, IPersistFile::Save clears the internal dirty flag after the save and sends IAdviseSink::OnSave notifications to any advisory connections (see also IOleAdviseHolder::SendOnSave). Also, in these operations, the object is in NoScribble mode until it receives an IPersistFile::SaveCompleted call.

In NoScribble mode, the object must not write to the file.

In the Save As scenario, the implementation should also send IAdviseSink::OnRename notifications to any advisory connections (see also IOleAdviseHolder::SendOnRename).

In the Save a Copy As scenario, the implementation does not clear the internal dirty flag after the save.

To determine whether the platform supports this interface, see Determining Supported COM APIs.

Notes to Callers

OLE does not call IPersistFile::Save. Typically, applications would not call it unless they are saving an object to a file directly, which is generally left to the end-user.

Requirements

See Also

Reference

IOleAdviseHolder::SendOnRename
IOleAdviseHolder::SendOnSave
IPersistFile::GetCurFile
IPersistFile::SaveCompleted