Share via


COleMessageFilter Class

Manages the concurrency required by the interaction of OLE applications.

class COleMessageFilter : public CCmdTarget

Members

Public Constructors

Name

Description

COleMessageFilter::COleMessageFilter

Constructs a COleMessageFilter object.

Public Methods

Name

Description

COleMessageFilter::BeginBusyState

Puts the application in the busy state.

COleMessageFilter::EnableBusyDialog

Enables and disables the dialog box that appears when a called application is busy.

COleMessageFilter::EnableNotRespondingDialog

Enables and disables the dialog box that appears when a called application is not responding.

COleMessageFilter::EndBusyState

Terminates the application's busy state.

COleMessageFilter::OnMessagePending

Called by the framework to process messages while an OLE call is in progress.

COleMessageFilter::Register

Registers the message filter with the OLE system DLLs.

COleMessageFilter::Revoke

Revokes the message filter's registration with the OLE system DLLs.

COleMessageFilter::SetBusyReply

Determines the busy application's reply to an OLE call.

COleMessageFilter::SetMessagePendingDelay

Determines how long the application waits for a response to an OLE call.

COleMessageFilter::SetRetryReply

Determines the calling application's reply to a busy application.

Remarks

The COleMessageFilter class is useful in visual editing server and container applications, as well as OLE automation applications. For server applications that are being called, this class can be used to make the application "busy" so that incoming calls from other container applications are either canceled or retried later. This class can also be used to determine the action to be taken by a calling application when the called application is busy.

Common usage is for a server application to call BeginBusyState and EndBusyState when it would be dangerous for a document or other OLE accessible object to be destroyed. These calls are made in CWinApp::OnIdle during user-interface updates.

By default, a COleMessageFilter object is allocated when the application is initialized. It can be retrieved with AfxOleGetMessageFilter.

This is an advanced class; you seldom need to work with it directly.

For more information, see the article Servers: Implementing a Server.

Inheritance Hierarchy

CObject

CCmdTarget

COleMessageFilter

Requirements

Header: afxole.h

See Also

Reference

CCmdTarget Class

Hierarchy Chart

CCmdTarget Class