Finalidad
Utiliza un argumento de búsqueda para buscar en documentos de texto identificados por una columna de texto. Los datos del descriptor de contexto de los elementos de texto encontrados se graban en una tabla de resultados. La información de examen acerca del rango y del número de coincidencias también puede grabarse en la tabla de resultados.
Sintaxis
DESRETURN DesGetSearchResultTable (SQLHDBC hdbc, char *pTableSchema, DESSMALLINT TableSchemaLength, char *pTableName, DESSMALLINT TableNameLength, char *pColumnName, DESSMALLINT ColumnNameLength, char *pSearchArgument, DESSMALLINT ArgumentLength, char *pResultSchema, DESSMALLINT ResultSchemaLength, char *pResultTableName, DESSMALLINT ResultTableNameLength, DESSEARCHOPTION SearchOption, DESBROWSEOPTION BrowseOption, DESBROWSEINFO *pBrowseInfo, DESMESSAGE *pErrorMessage);
Argumentos de la función
Tabla 14. Argumentos de DesGetSearchResultTable
Tipo de datos | Argumento | Uso | Descripción |
---|---|---|---|
SQLHDBC | hdbc | entrada | Un descriptor de contexto de conexión de base de datos. |
char * | pTableSchema | entrada | El esquema de la tabla base en la que se ha de buscar. |
DESSMALLINT | TableSchemaLength | entrada | La longitud de pTableSchema (sin incluir un terminador de byte nulo) o DES_NTS. |
char * | pTableName | entrada | Puntero para el nombre de la tabla base en la que se ha de buscar. |
DESSMALLINT | TableNameLength | entrada | La longitud de pTableName (sin incluir el terminador de byte nulo) o DES_NTS. |
char * | pColumnName | entrada | Puntero para el nombre de la columna a la que se ha de direccionar la búsqueda de texto que se intenta realizar. La columna debe ser de tipo DESTEXTH. |
DESSMALLINT | ColumnNameLength | entrada | La longitud de pColumnName (sin incluir el terminador de byte nulo) o DES_NTS. |
char * | pSearchArgument | entrada | Puntero para el argumento de búsqueda de texto. |
DESSMALLINT | ArgumentLength | entrada | La longitud de pSearchArgument (sin incluir el terminador de byte nulo) o DES_NTS. |
char * | pResultSchema | entrada | Puntero para el esquema que contiene la tabla de resultados. |
DESSMALLINT | ResultSchemaLength | entrada | La longitud de pSchemaName (sin incluir el terminador de byte nulo) o DES_NTS. |
char * | pResultTableName | entrada | Puntero para el nombre de la tabla de resultados que ha creado previamente en la que se ha de almacenar el resultado de la búsqueda. Consulte la Figura 15 para ver la estructura de esta tabla. |
DESSMALLINT | ResultTableNameLength | entrada | La longitud de pResultTableName (sin incluir el terminador de byte nulo) o DES_NTS. |
DESSEARCHOPTION | SearchOption | entrada | Una opción que determina si está pidiendo información de rango, para el
número de coincidencias o sólo para los descriptores de contexto de los
documentos de texto coincidentes.
Esta opción determina el contenido de la tabla de resultados, tal como se describe en el apartado Uso. |
DESBROWSEOPTION | BrowseOption | entrada | Reservado. |
DESBROWSEINFO * | pBrowseInfo | salida | Puntero para la información de examen o un puntero para nulo, dependiendo del valor de BrowseOption. |
DESMESSAGE * | pErrorMessage | salida | Texto de mensaje definido para la implementación. Si se produce un error, DB2 Text Extender devuelve un código de error y un mensaje de error. El programa de aplicación asigna el tamaño de almacenamiento intermedio DES_MAX_MESSAGE_LENGTH. Si pErrorMessage es el puntero nulo, no se devuelve ningún mensaje de error. |
La conexión con la base de datos debe establecerla el programa de aplicación llamando a DesGetSearchResultTable.
El nombre pResultTableName hace referencia a una tabla de resultados que se ha creado con anterioridad. El programa de utilidad DESRESTB del directorio de ejemplos crea una tabla de resultados para los descriptores de contexto de texto. Después de llamar a esta función, la tabla de resultados contiene información que identifica los valores de texto que coinciden con el argumento de búsqueda.
Esta es la estructura de la tabla de resultados:
Figura 15. Estructura de la tabla de resultados
![]() |
El tipo de datos de TEXTHANDLE es DB2TEXTH o DB2TEXTFH. El tipo de datos de RANK es DOUBLE. El tipo de datos de MATCHES es INTEGER.
El argumento de búsqueda de pSearchArgument se describe en el Capítulo 12, Sintaxis de los argumentos de búsqueda.
Si el valor de BrowseOption es BROWSE, DB2 Text Extender devuelve información de examen desde la aplicación de búsqueda de DB2 Text Extender ubicada en el servidor. pBrowseInfo apunta a la información de examen que es la entrada para DesStartBrowseSession. Si el valor de BrowseOption es NO_BROWSE pBrowseInfo apunta a nulo.
Códigos de retorno