Documentation
(C) IBM Corp. 1996, 1999

Text Extender: Administration and Programming

HANDLE_LIST

The HANDLE_LIST function searches for text documents using a search argument and returns a value of type DB2TEXTHLISTP or DB2TEXTFHLISTP that points to a list of handles for the found documents.
Note:The pointer to this list is accessible only within the scope of the SQL statement using this function.

If no text documents are found containing the search term(s), the list of handles is empty. Use the NO_OF_DOCUMENTS function to find whether the list is empty.

If you are searching for text stored in a column of a base table, use this function only once per statement. If you are searching for text stored in a column of a view, and the view is made from more than one base table (that is, it is a union view), use one handle for each handle column as the handle input argument to the HANDLE_LIST function.
Tip

This function is a feature of an earlier release of Text Extender. For compatibility reasons it continues to be supported, Its functionality has been superceded by the SEARCH_RESULT PDF.

Function syntax

>>-HANDLE_LIST---(--handle--,--search-argument----)------------><
 

Function parameters

handle
An expression whose result is a value of type DB2TEXTH or DB2TEXTFH. It is usually the handle column containing the handles of the text documents to be searched. It can also be a prototype handle extracted from the TEXTCOLUMNS catalog view.

search-argument
A string of type LONG VARCHAR containing the terms to be searched for. See Chapter 10, Syntax of search arguments.


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