9.3.2 OleRenameClientDoc

OLESTATUS OleRenameClientDoc(lhClientDoc, lpszNewDocname)

LHCLIENTDOC lhClientDoc;

char * lpszNewDocname;

The OleRenameClientDoc function informs the client application library that a document has been renamed.

Parameter Description

lhClientDoc Identifies the document that has been renamed.
lpszNewDocname Points to a null-terminated string specifying the new name of the document.

A client application calls this function when a document name has changed—for example, when the user chooses the Save or Save As command.

Client applications should register open documents with the client DLL and notify it when a document is renamed, closed, saved, or reverted to a changed state.

The return value is OLE_OK if successful; otherwise, it could be OLE_ERROR_HANDLE.

See AlsoOleRegisterClientDoc, OleRevokeClientDoc, OleRevertClientDoc, OleSavedClientDoc