MSMQManagement.FormatName

  • Article

 

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 FormatName 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 format name for the destination queue and the corresponding outgoing queue.

Data type: String
Run-time access: Read-only 
Property FormatName As String

Property Value

A String that contains the format name.

Remarks

The format name of the queue can be provided explicitly in the call to MSMQManagement.Init, or it can be derived from the path name supplied to the MSMQManagement.Init call.

Note

The format name of a queue is not a queue property such as the path name of the queue.

Message Queuing uses several types of format names, including private, public, and direct format names. For information on the syntax of all format name types, see Format Names.

Equivalent API Function Property

When using API functions, the equivalent property is PROPID_MGMT_QUEUE_FORMATNAME.

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
MSMQManagement.Init
PROPID_MGMT_QUEUE_FORMATNAME