Documentation
(C) IBM Corp. 1996, 1999

Text Extender: Administration and Programming

INIT_TEXT_HANDLE

The INIT_TEXT_HANDLE function returns a partially initialized handle that contains preset values for the text's format or language. It can be inserted into a handle column. This is useful when you add a row containing text whose format and language are not the same as those specified in the text configuration settings.

The returned handle is a value of type DB2TEXTH.

If you intend to search in text that is stored in external files rather than in a DB2 UDB table, you can use the INIT_TEXT_HANDLE function to return a completely initialized handle that contains preset values for the text's CCSID, format, language, and the location of the file.

The returned handle is a value of type DB2TEXTFH.

Use the INIT_TEXT_HANDLE function to insert or update handle values.

Function syntax

>>-INIT_TEXT_HANDLE---(--format--,--language--)----------------><
 
>>-INIT_TEXT_HANDLE--(--CCSID--,--format--,--language--,--file-name--)-->
 
>--------------------------------------------------------------><
 

Function parameters

format
A string of type VARCHAR(30) specifying the new document format setting. The formats supported are listed in Formats.

language
A string of type VARCHAR(30) specifying the new document language setting. The supported languages are listed in Languages.

file-name
A string of type VARCHAR(150) specifying the absolute path and file name of the external file that is to be associated with the handle. To have access to the file in UNIX, the DB2 UDB instance owner must be included in the file access permissions. For OS/2 and Windows users, the file access permissions must include the logon user IDs.


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