MSMQDestination.PathName

 

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 PathName property of the MSMQDestination object, which can represent one or more queues, specifies the path name of a public or private queue.

Setting this property initializes the MSMQDestination object for sending messages.

Data type:String

Run-time access:Read/write

Property PathName As String

Property Value

A String that contains the path name of a public or private queue.

Remarks

Setting the PathName property initializes the MSMQDestination object so that the object can be opened explicitly by calling MSMQDestination.Open or implicitly by referencing the object in MSMQMessage.Send and closes the object if it is open.

Setting the PathName property also resets the MSMQDestination.ADsPath property to a zero-length string and sets the MSMQDestination.FormatName property. Message Queuing generates the appropriate public or private format name from the queue path name.

The PathName property is a string, and Message Queuing COM components ignore any characters that follow the first Null character in a string without returning an error.

Equivalent API Function

The equivalent API function for generating the appropriate format name for a local private queue or a public queue from its path name is MQPathNameToFormatName.

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

MSMQDestination
MSMQDestination.FormatName
MSMQDestination.Open
MSMQMessage.Send