OleRevokeClientDoc

3.1

  #include <ole.h>    

  OLESTATUS OleRevokeClientDoc(lhClientDoc)    
  LHCLIENTDOC lhClientDoc; /* handle of client document */

The OleRevokeClientDoc function informs the client library that a document is no longer open.

Parameters

lhClientDoc

Identifies the document that is no longer open. This handle is invalid following the call to OleRevokeClientDoc.

Return Value

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_ERROR_HANDLE OLE_ERROR_NOT_EMPTY

Comments

The client application should delete all the objects in a document before calling OleRevokeClientDoc.

Client applications should register open documents with the library and notify the library when a document is renamed, closed, saved, or restored to a changed state.

See Also

OleRegisterClientDoc, OleRenameClientDoc, OleRevertClientDoc, OleSavedClientDoc