IPersistFile::GetCurFile

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method retrieves either the absolute path to the object's current working file or, if there is no current working file, the object's default file name prompt.

Syntax

HRESULT GetCurFile(
  LPOLESTR* ppszFileName 
);

Parameters

• ppszFileName
  [out] Points to the location of a pointer to a zero-terminated string containing the path for the current file or the default file name prompt (such as *.txt). If an error occurs, ppszFileName is set to NULL.

Return Value

• S_OK
  A valid absolute path was successfully returned.

• S_FALSE
  The default save prompt was returned.

• E_OUTOFMEMORY
  The operation failed due to insufficient memory.

• E_FAIL
  The operation failed due to some reason other than insufficient memory.

Remarks

This method returns the current file name or the default save prompt for the object.

This method allocates memory for the string returned in the ppszFileName parameter using the IMalloc::Alloc method. The caller is responsible for calling the IMalloc::Free method to free the string. Both the caller and this method use the OLE task allocator provided by a call to CoGetMalloc.

The LPOLESTR type indicates a wide character string (two bytes per character); otherwise, the string has one byte per character.

The file name returned in ppszFileName is the name specified in a call to IPersistFile::Load when the document was loaded; or in IPersistFile::SaveCompleted if the document was saved to a different file.

If the object does not have a current working file, it should supply the default file name prompt that it would display in a Save As dialog box . For example, the default save prompt for a word processor object could be *.txt.

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

Notes to Callers

OLE does not call the IPersistFile::GetCurFile method. Applications would not call this method unless they are also calling the save methods of this interface.

In saving the object, you can call this method before calling IPersistFile::Save to determine whether the object has an associated file.

If this method returns S_OK, you can then call IPersistFile::Save with a NULL file name and a TRUE value for the fRemember parameter to tell the object to save itself to its current file.

If this method returns S_FALSE, you can use the save prompt returned in the ppszFileName parameter to ask the user to provide a file name. Then, you can call IPersistFile::Save with the file name that the user entered to perform a Save As operation.

Requirements

See Also

Reference

IPersistFile::Load
IPersistFile::Save
IPersistFile::SaveCompleted