IPersistFile::GetCurFile - OLE Programmer's Reference (ole.hlp)

IPersistFile::GetCurFile

Returns either the absolute path to the object's current working file or, if there is no current working file, the object's default save prompt .

HRESULT GetCurFile(

LPOLESTR *ppszFileName	//Pointer to the path for the current file or the default save prompt
);

Parameter
ppszFileName

[out]Points to a zero-terminated string containing the path for the current file or the default save prompt. If an error occurs, *ppszFileName is set to NULL.

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

Comments
This method returns the current filename 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 allocator returned by CoGetMalloc(MEMCTX_TASK, ...).

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

The filename returned in ppszFileName is the name specified in the IPersistFile::Load method 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 return the default filename prompt that it would display in a "Save As" dialog. For example, the default save prompt for a word processor object could be:

Notes to Callers
OLE does not call the IPersistFile::GetCurFile method. Typically, applications do not either.

If you want to perform a "Save" operation on 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 filename 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 end user to provide a filename. Then, you can call IPersistFile::Save with the filename that the user entered to perform a "Save As" operation.

See Also
IPersistFile::Load, IPersistFile::Save, IPersistFile::SaveCompleted

More Online Helps

Win32 Programmer's Reference (win32.hlp)
Win32 Multimedia Programmer's Reference (mmedia.hlp)
Microsoft Windows Pen API Programmer's Reference (penapi.hlp)
Microsoft Windows Sockets 2 Reference (sock2.hlp)
Microsoft Windows Telephony API (TAPI) Programmer's Reference (sock2.hlp)
Unix Manual Pages

greatis just4fun network