MSMQOutgoingQueueManagement.EodGetSendInfo

 

Applies To: Windows 10, Windows 7, Windows 8, Windows 8.1, Windows Server 2008, Windows Server 2008 R2, Windows Server 2012, Windows Server 2012 R2, Windows Server Technical Preview, Windows Vista

(Introduced in MSMQ 3.0. This method is not implemented in Windows XP. If called, it returns E_NOTIMPL.) The EodGetSendInfo method of the MSMQOutgoingQueueManagement object, which represents the state of an outgoing queue, returns an MSMQCollection object that contains 11 elements of exactly-once-delivery (EOD) information about the outgoing queue.

Function EodGetSendInfo
() As MSMQCollection  

Parameters

This method has no parameters.

Return Values

An MSMQCollection object that contains the elements of EOD information (in C++, a smart pointer to the IMSMQCollection interface).

Remarks

The MSMQCollection object returned by the EodGetSendInfo method contains 11 elements of EOD information. Seven of these elements contain property values for the message stream:

• EodLastAckCount

• EodLastAckTime

• EodNoAckCount

• EodNoReadCount

• EodResendCount

• EodResendInterval

• EodResendTime

The other four elements are inner MSMQCollection objects that contain property values for specific messages in the message stream:

• EodFirstNonAck

• EodLastAck

• EodLastNonAck

• EodNextSeq

The inner MSMQCollection in each of these elements contains three elements: SeqID, SeqNo, and PrevNo.

You can use the MSMQCollection.Item method to retrieve the values of the individual elements of an MSMQCollection.

Note

The Item method is the default method for the MSMQCollection object. Therefore, its name can be omitted.

If no information is available for an MSMQCollection element, the EodGetSendInfo method returns a Variant containing Null in that element.

Equivalent API Function

When using API functions, call the MQMgmtGetInfo function and pass "QUEUE = <format name>" in the pObjectName parameter to retrieve the management properties that are equivalent to the 11 elements of EOD information.

Example Code

The following code fragment shows how to look at the property value contained in the EodLastAckTime element.

Dim coll As MSMQCollection  
Dim mgmt As New MSMQManagement  
Dim outqmgmt As MSMQOutgoingQueueManagement  
mgmt.Init PathName:="remotemachine\queue"  
Set outqmgmt = mgmt    ' An error is returned if a destination queue is used.  
Set coll = outqmgmt.EodGetSendInfo()  
MsgBox "Last order acknowledgment was at: "  & coll("EodLastAckTime")  

Requirements

Windows NT/2000/XP: Included in Windows Server 2003.

Windows 95/98/Me: Unsupported.

Header: Declared in Mqoai.h.

Library: Use Mqoa.lib.

See Also

MSMQCollection
MSMQCollection.Item
MSMQOutgoingQueueManagement