MSMQHNDLTOFORMAT

Returns a queue identifier that represents a format name based on its open handle.

Syntax

Example

Syntax

CALL MSMQHNDLTOFORMAT(hQueue, qid, rc);

Required Arguments

hQueue: Numeric, input

Specifies the MSMQ handle to an open queue. This parameter is obtained from a previous MSMQOPENQUEUE function call.

qid: Numeric, output

Returns the queue identifier that represents the format name of the queue.

rc: Numeric, output

Provides the return code from the CALL routine. If an error occurs, then the return code is nonzero. A return code of -1 reflects a SAS internal error. Otherwise, it represents an MSMQ error code. You can use the SAS function SYSMSG() to obtain a textual description of the return code.

Example: Example

This example obtains the format name of a queue from a queue handle.

length msg $ 200;
qid=0;
rc=0;
CALL MSMQHDNLTOFORMAT(hQueue, qid, rc);
if rc ^= 0 then do;
   put 'MSMQHndlToFormat: failed';
   msg = sysmsg();
   put msg;
end;
else put 'MSMQHndlToFormat: succeeded';