MSMQ Open Queue (Magic xpa 3.x)
The MSMQ Open Queue program opens a messaging queue and returns a numeric reference for the queue. The parameters and return value for the MSMQ Open Queue program are:
|
|
Queue Format Name
|
Numeric (1). Input. A number representing the QueueInfo FormatName. The valid values are:
-
0 (Direct=OS)
-
1 (Direct=TCP)
-
2 (Public)
-
3 (Private)
|
Computer Address
|
Alpha (250). Input. The Computer Address is as follows:
-
For FormatName type 0, it is the host name of the host computer
-
For FormatName type 1, it is the IP address
-
For Format Name type 2 (Public), it is blank
-
For FormatName type 3 (Private), it is the Computer GUID
|
Queue Name
|
Alpha (250). Input. A string specifying the name of the queue to open. The Queue Name can also be:
-
For Format Name type 2 (Public), it is the QueueGUID
-
For Format Name type 3 (Private), it is the Queue Number
|
Access method
|
Alpha (1). Input. A character representing the access. The valid values are:
-
V: View Messages are read and left in the queue.
-
W: Write Messages are written to the queue.
-
R : Read Messages are read and removed from the queue.
|
Share method
|
Alpha (1). Input. A string representing the sharing of the queue. The valid values are:
-
A: Queue is available to all. If access = W or V, this must be used.
-
W: Other sessions cannot read from this queue.
|
Return value
|
Numeric (15). When the connection is successful, an entry is created in the Queue Memory Table and the index is returned. When the connection is not successful, it returns a negative value.
|