OLESTATUS OleRegisterClientDoc(lpszClass, lpszDoc, reserved, lplhDoc)
LPCSTR lpszClass;
LPCSTR lpszDoc;
LONG reserved;
LHCLIENTDOC FAR * lplhDoc;
The OleRegisterClientDoc function registers an open client document with the client DLL and returns a handle to that document.
Parameter | Description |
lpszClass | Points to a null-terminated string specifying the class of the client document. |
lpszDoc | Points to a null-terminated string specifying the location of the client document. (This value should be a fully-qualified path name.) |
reserved | Reserved. Must be zero. |
lplhDoc | Points to a handle to the client document, when the function returns. This handle is used to identify the document in other document-management functions. |
The name specified in the lpszDoc parameter must be "Clipboard" when a document being copied to the clipboard exists only because the client application is copying Native data that contains objects.
Client applications should register open documents with the DLL and notify it when a document is renamed, closed, saved, or restored to a changed state.
The return value is OLE_OK if successful; otherwise, it could be one of the following:
OLE_ERROR_NAME
OLE_ERROR_MEMORY
See AlsoOleRevokeClientDoc