VA FileMan V. 22.0 Programmer Manual Banner


Main Chapter Getting Started Manual Advanced User Manual

Browser API


This procedure displays word processing fields, as well as allowing navigation throughout the text, in a FileMan-compatible database using FileMan's Browser facility.

Input Parameters

(Required) File or subfile number.


(Required) Standard IENS indicating internal entry number string.


(Required) Word processing field name or number.


(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 text 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.

(Optional) Text that is centered in header. Document title.


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


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


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


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

NOTE: The TOP and BOTTOM parameters define the boundaries of the scroll region.


A successful call results in the Browser screens being displayed and enables the user to utilize the Browser to view and navigate through word processing fields in a FileMan-compatible database.

>D WP^DDBR(999088,"12,","TEXT","N","Programming SAC")

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 set up issues.

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)=""
Margin Note

Browser always begins at column 1.

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.


Reviewed/Updated: March 10, 2007