VA FileMan V. 22.0 Programmer Manual Banner


 

Main Chapter Getting Started Manual Advanced User Manual

Browser API


BROWSE^DDBR

This procedure enables the user to utilize FileMan's Browser to view and navigate through a document stored in a sequential local or global array.

Format
BROWSE^DDBR(SOURCE_ARRAY,FLAGS,TITLE,LINE,TABS,TOP,BOTTOM)
Input Parameters
SOURCE_ARRAY

(Required) Source array in a closed root format, passed by value which is the location of a sequential local or global array containing text. This array can optionally include the ",0)" subscript nodes which are contained in FileMan word processing structures.

FLAGS

(Optional) Flags to control processing.

N No copy of the document is made. The Browser will use the source document. Useful for long static documents.

CAUTION: When the N flag is used, the Browser does not make a copy of the text; instead it uses the actual record array to browse through. Thus, it is best used when documents stored in word processing fields are static and are not likely to be edited by another user during the browse session. This may be preferable if the source array is a scratch global and is very large. Time and resources are saved by not having to copy such a structure into ^TMP("DDB",$J).
R Restrict switching.

See Switch function in the "Details and Features" section.
TITLE

(Optional) Text centered in screen title.

LINE

(Optional) The line in the document that would be at the bottom margin of the opening screen.

TABS

(Optional) Closed array root, passed by value; used to scroll horizontally. If not set, the Browser provides default tab stops. Also see "Setting Tab Stops" under the "Details and Features" section.

TOP

(Optional) A number representing the location of the title bar of the Browser screen.

BOTTOM

(Optional) A number representing the location of the status bar of the Browser screen.

Output

A successful call enables the user to utilize the Browser to view and navigate throughout a document stored in a sequential local or global array.

Example
    >K ^TMP("EXAMPLE",$J)
    >N I F I=1:1:300 S ^TMP("EXAMPLE",$J,I)="THIS IS LINE "_I
    
    >D BROWSE^DDBR("^TMP(""EXAMPLE"",$J)","N","Example")

The Browser screen displays as follows:

----------------------------------------------------------------------------------
                                      Example
----------------------------------------------------------------------------------
THIS IS LINE 1
THIS IS LINE 2
THIS IS LINE 3
THIS IS LINE 4
THIS IS LINE 5
THIS IS LINE 6
THIS IS LINE 7
THIS IS LINE 8
THIS IS LINE 9
THIS IS LINE 10
THIS IS LINE 11
THIS IS LINE 12
THIS IS LINE 13
THIS IS LINE 14
THIS IS LINE 15
THIS IS LINE 16
THIS IS LINE 17
THIS IS LINE 18
THIS IS LINE 19
THIS IS LINE 20
THIS IS LINE 21
THIS IS LINE 22
----------------------------------------------------------------------------------
Col>   1 |<PF1>H=help <PF1>E=Exit| Line>     22 of 300     Screen>     1 of 14
----------------------------------------------------------------------------------


Error Codes Returned
200 Invalid field.
202 Invalid parameter.
309 Multiple field. Invalid file and IENS.
401 Data Dictionary reference for file and field not valid.
501 Extended reference invalid.
510 Invalid type in data dictionary.
601 Record entry does not exist.
602 Record unavailable.
842 Device/Terminal type setup issues.

NOTE: For additional information about Browser error messages, see the "How Information is Returned" and "Contents of Arrays" sections in the "DataBase Server (DBS) API" chapter.

Details and Features
Switch Function

Switch allows the user to view more than one document. When using the Switch (<PF1>S) function in the Browser to select other FileMan word processing fields, it is important to note that browsing is done directly on the actual record text. Users can only access word processing fields in FileMan files for which they have Read access.

Setting Tab Stops

This will set up the TAB with stops at every tenth column.

    F I=10:10:100 S TAB(I)="" 
 
    TAB(10)=""
    TAB(20)=""
    TAB(30)=""
       .
       .
       .
    TAB(90)=""
    TAB(100)=""

NOTE: Browser always begins at column 1.

 


Reviewed/Updated: March 10, 2007