Messenger.CleanupInterval

Messenger     See also    

Time period in which presence of expired messages will be checked.

Declaration

[C++]
    void setCleanupInterval(unsigned long Value);
    unsigned long getCleanupInterval(void);

[Pascal]
    property CleanupInterval: Cardinal;

[VB6]
    Property IMCXMessenger2.CleanupInterval As Long

[ActiveX]
    HRESULT _stdcall IMCXMessenger2.CleanupInterval([in] long Value );
    HRESULT _stdcall IMCXMessenger2.CleanupInterval([out, retval] long * Value );

[C#]
    public int CleanupInterval;

[VB.NET]
    Public Property CleanupInterval As Integer

[Java]
    public void setCleanupInterval(int value);
    public int getCleanupInterval();

[Java ME]
    public void setCleanupInterval(int value);
    public int getCleanupInterval();

[Palm]
    not applicable;

[DLL]
    void __stdcall MCMessengerSetCleanupInterval(HMCMessenger h, unsigned long value);
    unsigned long __stdcall MCMessengerGetCleanupInterval(HMCMessenger h);

Description

    Value of time period (in milliseconds) in which presence of expired messages will be checked. All expired messages will be deleted.
    Note: if CleanupInterval value is 0 then expired messages will never be checked.

    This property affects the functionality of SendMessageTimeoutCallback method. OnTimeout callback is not called if the cleanup is not done, and CleanupInterval defines, how frequently cleanup is done (given that you call DispatchMessages frequently enough).