NDC comm CompuFax user manual Fdbscan scancontext, streamid, One

Models: CompuFax

1 133
Download 133 pages 2.7 Kb
Page 109
Image 109

This parameter gives the address of the context data area in the user program. The contents of this area are completely user defined.

name: size

type: word unsigned

access: read only

mechanism: by reference

The size in bytes of the user context. This specifies the amount of data to save from the user's programs.

Return Value:

FDB$_N ORMAL N ormal successful completion

FDB$_N OSTREAM If the specified stream is not open

10.1.3.8 FDB_SCAN

This function gives the database application the means to scan the list of currently open streams. It returns the ID for each open stream in successive calls.

Calling Sequence:

FDB_SCAN scan_context, stream_id

Arguments

name: scan_context

type: longword unsigned

access: read / write

mechanism: by reference

This is the context of the scan. On the first call, it is zero to begin a new sequence. Successive calls should use the context from the previous call. When the scan is complete, this is returned as zero to indicate no more streams.

name: stream_id

type: longword signed

access: write only

mechanism: by reference

If scan_context is nonzero, this will contain a valid stream identifier.

Return Value:

N one.

Notes: This function is intended to allow the user to do startup initialization. The user would use FDB_GET_CONTEXT for each stream returned and would do any initialization required.

This function should not be used when a call to FDB_GET which specified an AST has not completed. This function is not reentrant.

The user should make no assumption about the order in which streams are returned. The order may be random.

8 5

Page 109
Image 109
NDC comm CompuFax user manual Fdbscan scancontext, streamid, One