Documentation
(C) IBM Corp. 1996, 2000

DB2 Text Extender Administración y programación

DesGetBrowseInfo

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

RC_SUCCESS
RC_NO_BROWSE_INFO
 
RC_ALLOCATION_ERROR
RC_FILE_IO_PROBLEM
RC_INTERNAL_ERROR
RC_INVALID_PARAMETER
RC_PARSER_INVALID_ESCAPE_CHARACTER
RC_PARSER_INVALID_USE_OF_ESCAPE_CHAR
RC_PARSER_SYNTAX_ERROR
RC_SE_COMMUNICATION_PROBLEM
RC_SE_EMPTY_INDEX
RC_SE_EMPTY_QUERY
RC_SE_FUNCTION_DISABLED
RC_SE_FUNCTION_IN_ERROR
RC_SE_INCORRECT_HANDLE
RC_SE_INDEX_DELETED
RC_SE_INDEX_NOT_ACCESSIBLE
RC_SE_INDEX_SUSPENDED
RC_SE_INSTALLATION_PROBLEM
RC_SE_IO_PROBLEM
RC_SE_MAX_NUMBER_OF_BUSY_INDEXES
RC_SE_MAX_OUTPUT_SIZE_EXCEEDED
RC_SE_NOT_ENOUGH_MEMORY
RC_SE_PROCESSING_LIMIT_EXCEEDED
RC_SE_QUERY_TOO_COMPLEX
RC_SE_SERVER_BUSY
RC_SE_SERVER_CONNECTION_LOST
RC_SE_SERVER_NOT_AVAILABLE
RC_SE_UNEXPECTED_ERROR
RC_SE_UNKNOWN_INDEX_NAME
RC_SE_UNKNOWN_SERVER_NAME
RC_SE_WRITE_TO_DISK_ERROR
 
Avisos: Los siguientes códigos de retorno indican que la función ha devuelto un resultado, pero puede que no sea tal como se esperaba.
 
RC_SE_CONFLICT_WITH_INDEX_TYPE
RC_SE_DICTIONARY_NOT_FOUND
RC_SE_STOPWORD_IGNORED
RC_SE_UNKNOWN_SECTION_NAME
RC_SE_DOCMOD_READ_PROBLEM

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.


[ Principio de página | Página anterior | Página siguiente | Contenido | Índice ]