Documentation
(C) IBM Corp. 1996, 1999

Text Extender: Administration and Programming

FORMAT

The FORMAT function does one of the following:

The returned document format is a string of type VARCHAR(30). The returned handle is of type DB2TEXTH or DB2TEXTFH.

This is the format parameter used for indexing the corresponding text document. The document formats supported are listed in Formats.

Function syntax

          (1)
>>-FORMAT-------(--handle--)-----------------------------------><
 

Notes:

  1. Returns a format value, type VARCHAR(30).

          (1)
>>-FORMAT--------(--handle--,--format----)---------------------><
 

Notes:

  1. Returns a handle, type DB2TEXTH or DB2TEXTFH.

Function parameters

handle
An expression whose result is a value of type DB2TEXTH or DB2TEXTFH. It is usually the name of a handle column from which the format setting is to be returned or set.

format
The new document format setting of data type VARCHAR(30).

If format is specified, this document format is set in the handle; in this case, the handle is returned instead of the format setting.


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]