OleRename

  OLESTATUS OleRename(lpObject, lpszNewname)    
  LPOLEOBJECT lpObject; /* pointer to object being renamed */
  LPCSTR lpszNewname; /* pointer to string for new object name */

The OleRename function informs the client library that an object is being renamed.

Parameters

lpObject

Points to the object that is being renamed.

lpszNewname

Points to a null-terminated string specifying the new name of the object.

Return Value

The return value is OLE_OK if the function is successful. Otherwise, it is an error value, which can be OLE_ERROR_OBJECT.

Comments

A client application should call the OleRename function whenever it changes the name of an object.

Object names need not be seen by the user. They must be unique within the containing document and must be preserved when the document is saved.

See Also

OleQueryName