MSMQManagement.ForeignStatus

 

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). The ForeignStatus property of the MSMQManagement object, which represents the elements of the state of a queue that are common to destination and outgoing queues, returns a flag that indicates whether a destination queue is a foreign queue or whether an outgoing queue is associated with a foreign queue.

Data type: Long
Run-time access: Read-only
Property ForeignStatus As Long  

Property Value

The ForeignStatus property can have any one of the following values:

MQ_STATUS_FOREIGN

For destination queues, the queue is part of a foreign messaging system.

For outgoing queues, the queue is associated with a foreign queue.

MQ_STATUS_NOT_FOREIGN

For destination queues, the queue is not part of a foreign messaging system.

For outgoing queues, the queue is not associated with a foreign queue.

STATUS_UNKNOWN

Message Queuing was not able to determine the foreign status of the queue.

For outgoing queues, this flag is returned if the queue is a remote private queue, or if the queue is a remote public queue and the remote queue manager is offline.

Remarks

The MSMQManagement object can be initialized to refer to an active destination or outgoing queue, depending on the parameters passed to the MSMQManagement.Init method when the object is initialized. If the MSMQManagement object represents the state of an outgoing queue, the ForeignStatus property indicates whether the destination queue associated with it is foreign.

Equivalent API Function Property

When using API functions, the equivalent property is PROPID_MGMT_QUEUE_FOREIGN.

Requirements

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

Windows 95/98/Me: Unsupported.

Header: Declared in Mqoai.h.

Library: Use Mqoa.lib

See Also

MSMQManagement
PROPID_MGMT_QUEUE_FOREIGN