| #include <ole.h> |
| OLESTATUS OleClone(lpObject, lpClient, lhClientDoc, lpszObjname, lplpObject) | |||||
| LPOLEOBJECT lpObject; | /* address of object to copy | */ | |||
| LPOLECLIENT lpClient; | /* address of OLECLIENT for new object | */ | |||
| LHCLIENTDOC lhClientDoc; | /* long handle of client document | */ | |||
| LPCSTR lpszObjname; | /* address of string for object name | */ | |||
| LPOLEOBJECT FAR* lplpObject; | /* address of pointer to new object | */ | |||
The OleClone function makes a copy of an object. The copy is identical to the source object, but it is not connected to the server.
lpObject
Points to the object to copy.
lpClient
Points to an OLECLIENT structure for the new object.
lhClientDoc
Identifies the client document in which the object is to be created.
lpszObjname
Points to a null-terminated string specifying the client's name for the object. This name must be unique with respect to the names of any other objects in the document and cannot contain a slash mark (/).
lplpObject
Points to a variable where the library will store the long pointer to the new object.
The return value is OLE_OK if the function is successful. Otherwise, it is an error value, which may be one of the following:
OLE_BUSY
OLE_ERROR_HANDLE
OLE_ERROR_OBJECT
OLE_WAIT_FOR_RELEASE
Client applications often use the OleClone function to support the Undo command.
A client application can supply a new OLECLIENT structure for the cloned object, if required.