OleCopyFromLink

OLESTATUS OleCopyFromLink(lpObject, lpszProtocol, lpClient, lhClientDoc, lpszObjname, lplpObject)
LPOLEOBJECT lpObject;	/* pointer to object to embed	*/
LPCSTR lpszProtocol;	/* pointer to protocol name	*/
LPOLECLIENT lpClient;	/* pointer to client structure	*/
LHCLIENTDOC lhClientDoc;	/* long handle to client document	*/
LPCSTR lpszObjname;	/* string for object name	*/
LPOLEOBJECT FAR* lplpObject;	/* pointer to pointer to new object	*/

The OleCopyFromLink function makes an embedded copy of a linked object.

Parameters

lpObject

Points to the linked object that is to be embedded.

lpszProtocol

Points to a null-terminated string specifying the name of the protocol required for the new embedded object. Currently this value can be “StdFileEditing”, the name of the object linking and embedding protocol.

lpClient

Points to an OLECLIENT structure for the new object.

lhClientDoc

Identifies the client document in which the object is being created.

lpszObjname

Points to a null-terminated string specifying the client's name for the object.

lplpObject

Points to a variable where the library will store the long pointer to the new object.

Return Value

The return value is OLE_OK if the function is successful. Otherwise, it is an error value, which can be one of the following:

OLE_BUSY
OLE_ERROR_HANDLE
OLE_ERROR_NAME
OLE_ERROR_OBJECT
OLE_ERROR_PROTOCOL
OLE_WAIT_FOR_RELEASE

Comments

Making an embedded copy of a linked object may involve starting the server application.