QUEUE_SETHDR

QUEUE_SETHDR

Define queue header information.

Syntax
QUEUE_SETHDR Example

Syntax

CALL QUEUE_SETHDR(queueId, desc, respQ, datetime, corr, rc);

Where... Is type... And represents...

queueId N queue identifier

desc C user-specified description

respQ C user-specified response queue's name

datetime N datetime time-out value (currently unsupported, value will be ignored)

corr N user-specified correlation value

rc N return code

Where...	Is type...	And represents...
queueId	N	queue identifier
desc	C	user-specified description
respQ	C	user-specified response queue's name
datetime	N	datetime time-out value (currently unsupported, value will be ignored)
corr	N	user-specified correlation value
rc	N	return code

QUEUE_SETHDR defines the queue header information that will accompany the message when the QUEUE_SEND CALL routine is invoked on this particular queue. Any information that is supplied by QUEUE_SETHDR is surfaced on the receiving side by using QUEUE_GETHDR. All parameters are required, but numerics may be set to 0 and strings may be set to double quotes (" ") to indicate that no value should be set for this particular parameter.

The queueId parameter identifies the queue.

The desc parameter is user-supplied, descriptive text.

The respQ parameter is the user-supplied response queue name.

The datetime parameter is a time-out date-time stamp. However, this parameter is not supported at this time and should be set to 0.

The corr parameter is the user-specified correlator value.

If an error occurs, rc is updated and returned as a non-zero value. Use the SYSMSG() function to print the message that is associated with the non-zero rc.

QUEUE_SETHDR Example

This example defines the header information to be included with the queue that is identified by queueId. Only the description and response queue name are specified.

desc = "Information concerning 
        employee database.";
resp = "Example Queue";
dt = 0;
corr = 0;
call queue_sethdr(queueId, desc,resp, dt, corr,rc);

Chapter Contents
Previous
Next
Top of Page