NDC comm CompuFax User Manual

Page 104

Advertising
background image

8 0

8.

Wait for another request using FDB_GET.

9.

When no more matches exist for a particular key, either use FDB_NOMATCH or FDB_CLOSE to
return this status to the requestor.

10.1.3 Com puFax Dat abase Func t ion Library
10.1.3.1 FDB_CLOSE

This function closes a database stream. It should be called when FDB$_CLOSE is returned by FDB_GET.
It may also be called any time the user desires to end a lookup sequence.

When a lookup sequence is complete, the user has the option of either returning a .no match. to the requestor
in which the requestor will close the stream or it may close the stream itself which will cause a .no match.
response to be automatically sent to the requestor.

Calling Sequence:
FDB_CLOSE stream_id

Arguments
name: stream_id
type: longword signed
access: read only
mechanism: by reference

This is the ID of the stream to close. If the specified stream is not open, no action is taken.

10.1.3.2 FDB_DELETE_MSG

This function de-allocates a message that was allocated with FDB_START_MSG without sending the
message. It would be used if an operation is aborted after a message is allocated. This function is used as an
alternative to sending the message. It should not be used for messages that have been sent.

Calling Sequence:
FDB_DELETE_MSG message

Arguments
name: message
type: unsigned longword
access: read only
mechanism: by reference

This is the message object that was previously allocated with fdb_start_msg.

10.1.3.3 FDB_GET

This function waits for a message and returns a message when one is received. This procedure may operate
either synchronously if no AST routine is passed or asynchronously if an AST routine is passed. If the server
shuts down while a GET is active or if it has shut down since the last GET, a failure status of
FDB$_SERDOWN is returned. Normally the database would exit on receipt of this status. If it does not shut
down, it should cancel any lookups in progress as the requests will be reissued by the server the next time it
starts.

Calling Sequence:
FDB_GET stream_id, lookup_key [,key_length]

Advertising