Discuss this help topic in MsgConnect Forum

Filter: C++  Pascal  C#  VB.NET  Java  Java ME  ActiveX  DLL 



Messenger.GetQueueStatus

Messenger     See also    


Returns information about messages in incoming queue.

Declaration

[C++]
    void GetQueueStatus(const char * QueueName, long MsgCodeLow, long MsgCodeHigh, long &MsgCount, long &MsgTotalSize, long &MsgMaxSize);

[Pascal]
    procedure GetQueueStatus( QueueName : string; MsgCodeLow, MsgCodeHigh : integer; var MsgCount : integer; var MsgTotalSize : integer; var MsgMaxSize : integer);

[VB6]
    Sub IMCXMessenger3.GetQueueStatus(QueueName As String, MsgCodeLow As Long, MsgCodeHigh As Long, MsgCount As Long, MsgTotalSize As Long, MsgMaxSize As Long)

[ActiveX]
    HRESULT _stdcall IMCXMessenger3.GetQueueStatus( [in] BSTR QueueName, [in] long MsgCodeLow, [in] long MsgCodeHigh, [out] long * MsgCount, [out] long * MsgTotalSize, [out] long * MsgMaxSize);

[C#]
    public void GetQueueStatus( String QueueName, int MsgCodeLow, int MsgCodeHigh, out int MsgCount, out int MsgTotalSize, out int MsgMaxSize);

[VB.NET]
    Public Sub GetQueueStatus(ByVal QueueName As String, ByVal MsgCodeLow As Integer, ByVal MsgCodeHigh As Integer, ByRef MsgCount As Integer, ByRef MsgTotalSize As Integer, ByRef MsgMaxSize As Integer)

[Java]
    public void GetQueueStatus( String QueueName, int MsgCodeLow, int MsgCodeHigh, IntegerHolder MsgCount, IntegerHolder MsgTotalSize, IntegerHolder MsgMaxSize);

[Java ME]
    public void GetQueueStatus( String QueueName, int MsgCodeLow, int MsgCodeHigh, IntegerHolder MsgCount, IntegerHolder MsgTotalSize, IntegerHolder MsgMaxSize);

[DLL]
    void __stdcall MCMessengerGetQueueStatus(HMCMessenger h, const char * QueueName, long MsgCodeLow, long MsgCodeHigh, long &MsgCount, long &MsgTotalSize, long &MsgMaxSize);

Parameters

  • [DLL]h - handle to the Messenger object that was returned by Create method

  • QueueName - The name of the incoming queue, whose status is queried. If this parameter is empty, all queues are checked.
  • MsgCodeLow - The lower boundary of the range of message codes, being checked.
  • MsgCodeHigh - The upper boundary of the range of message codes, being checked.
  • MsgCount - Upon return this parameter contains the number of messages that satisfy the conditions.
  • MsgTotalSize - Upon return this parameter contains the size of all messages that satisfy the conditions.
  • MsgMaxSize - Upon return this parameter contains the size of the largest message that satisfies the conditions.

Description

    Call this method to get some information about messages in incoming queue(s).

See also:     MCMessage structure    

Discuss this help topic in MsgConnect Forum