MSMQManagement.IsLocal

 

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 IsLocal property of the MSMQManagement object, which represents the elements of the state of a queue that are common to destination and outgoing queues, indicates whether the queue is local or remote.

Data type: Boolean
Run-time access: Read-only
Property IsLocal As Boolean  

Property Value

The IsLocal property can have one of the following values:

True (-1)

The queue is a local queue.

False (0)

The queue is a remote queue.

Remarks

The format name of an outgoing queue is also a format name of the corresponding destination queue. Thus, the value returned by IsLocal for an outgoing queue is determined by the location of the corresponding destination queue. This fact can be used to identify the outgoing queues included in the list of active queues on a specific computer returned by the MSMQApplication.ActiveQueues property. This is because the value returned by IsLocal for an active outgoing queue residing on the computer specified in the MSMQManagement object will refer to the destination queue residing on a different computer and will be False.

Connector queues are also treated as remote queues.

Equivalent API Function Property

When using API functions, the equivalent property is PROPID_MGMT_QUEUE_LOCATION.

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
MSMQApplication.ActiveQueues
PROPID_MGMT_QUEUE_LOCATION