MSMQ Call Routines

MSMQCREATECURSOR

Creates a cursor that is used to maintain a specific location in a queue when reading its messages.

Syntax
Arguments
Example

Syntax

CALL MSMQCREATECURSOR(hQueue, hCursor, rc);

Arguments

hQueue

Numeric, input

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

hCursor

Numeric, output

Returns the handle of the cursor that is used for looking at messages in the queue. The MSMQCREATECURSOR routine is used to create a cursor and obtain its handle.

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

This example creates a cursor.

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

Top of Page