OleRevokeServerDoc

3.1

#include <ole.h>

	OLESTATUS OleRevokeServerDoc(lhdoc)
	LHSERVERDOC lhdoc;	/* document handle, */

The OleRevokeServerDoc function revokes the specified document. A server application calls this function when a registered document is being closed or otherwise made unavailable to client applications.

Parameters

lhdoc

Identifies the document to revoke. This handle was returned by a call to the OleRegisterServerDoc function or was associated with a document by using one of the server-supplied functions that create documents.

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_WAIT_FOR_RELEASE

Comments

If this function returns OLE_WAIT_FOR_RELEASE, the server application should not free the OLESERVERDOC structure or exit until the library calls the server's Release function.