NDC comm CompuFax User Manual

Page 105

Advertising
background image

8 1

[, username] [, priority] [, status]
[, astrtn] [, astprm]
Arguments
name: stream_id
type: longword signed
access: write only
mechanism: by reference

On completion, this contains the database stream identifier for the received request.

name: lookup_key
type: charactercoded text string
access: write only
mechanism: by descriptor: fixed length string descriptor.

On completion, this will contain the lookup key from the received request as a space-filled string. All requests
for a single stream ID will contain the identical lookup key.

name: key_length
type: word unsigned
access: write only
mechanism: by reference

This parameter is optional. On completion this will contain the actual length of zero.

name: username
type: charactercoded text string
access: write only
mechanism: by descriptor fixed length string descriptor

On completion, this will contain the username of the user who queued the document. If this parameter is
passed as zero, the username is not returned.

name: priority
type: longword signed
access: write only
mechanism: by reference

On completion, this will be set to the queuing priority of the document that resulted in this lookup request.

name: status
type: longword unsigned
access: write only
mechanism: by reference

On completion this will contain the status of the operation. If the operation is being done synchronously (no
ASTRTN address passed) this status will be the same as the function return value. If the operation is being
done asynchronously this will be the completion status. This parameter is optional.

name: astrtn
type: procedure entry mask
access: call
mechanism: by reference

Advertising