Finalidad
Recibe un argumento de búsqueda para buscar en el texto identificado por un descriptor de contexto. Devuelve un puntero para la información de examen necesaria para que DesStartBrowseSession resalte los términos encontrados.
Sintaxis
DESRETURN DesGetBrowseInfo (SQLHDBC hdbc, SQLCHAR *pHandle, DESUSHORT HandleLength, char *pSearchArgument, DESSMALLINT ArgumentLength, DESBROWSEINFO *pBrowseInfo, DESMESSAGE *pErrorMessage);
Argumentos de la función
Tabla 12. Argumentos de DesGetBrowseInfo
Tipo de datos | Argumento | Uso | Descripción |
---|---|---|---|
SQLHDBC | hdbc | entrada | Un descriptor de contexto de conexión de base de datos. |
SQLCHAR * | pHandle | entrada | Puntero para un descriptor de contexto que se ha extraído de la base de datos. |
DESUSHORT | HandleLength | entrada | Longitud de pHandle. DES_NTS no puede utilizarse aquí. |
char * | pSearchArgument | entrada | Puntero para el argumento de búsqueda de texto que especifica la información que desea buscar. |
DESSMALLINT | ArgumentLength | entrada | La longitud de pSearchArgument (sin incluir un terminador de byte nulo) o DES_NTS. |
DESBROWSEINFO * | pBrowseInfo | salida | Puntero para la información de examen que contiene los datos necesarios para examinar un documento. Este puntero se pasa a DesStartBrowseSession. |
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. |
Uso
El programa de aplicación debe establecer una conexión con la base de datos antes de que llame a DesGetBrowseInfo.
Para el puntero para el argumento de búsqueda, se utiliza char* en lugar de SQLCHAR*. Esto es porque es posible que el valor del parámetro no venga de la base de datos.
Para la correlación entre los tipos de datos SQL y los tipos de datos C, debe utilizar el nombre simbólico SQL SQL_VARBINARY para un descriptor de contexto. El tipo de variables de sistema principal que apunta a la representación C de los valores de Descriptor de contexto es SQLCHAR*.
DB2 Text Extender asigna el almacenamiento para la información de examen. El programa de aplicación debe liberar el almacenamiento y los recursos relacionados llamando a DesFreeBrowseInfo.
Puesto que los valores de Descriptor de contexto son datos de bits y contienen varios caracteres '\0', debe especificar la longitud de pHandle.
El argumento de búsqueda de pSearchArgument se describe en el Capítulo 12, Sintaxis de los argumentos de búsqueda.
Códigos de retorno
Restricciones
Sólo puede llamarse a esta función después de haber realizado una conexión con la base de datos y utilizado una función de DB2 Text Extender para extraer un descriptor de contexto de la base de datos.