Documentation
(C) IBM Corp. 1996, 2000

DB2 Text Extender Administración y programación

DesStartBrowseSession

Finalidad

Inicia una sesión de examen, estableciendo el entorno necesario para examinar un documento de texto y resaltar sus coincidencias. Recibe un puntero para la información de examen, de DesGetBrowseInfo o de DesGetSearchResultTable, y devuelve un descriptor de contexto de sesión de examen para que lo utilicen las demás funciones de examen.

Sintaxis

DESRETURN
  DesStartBrowseSession
     (DESBROWSEINFO        BrowseInfo,
      char                 *pUserId,
      DESSMALLINT           UserIdLength,
      char                 *pPassword,
      DESSMALLINT           PasswordLength,
      DESBROWSESESSION     *pBrowseSession,
      DESMESSAGE           *pErrorMessage);

Argumentos de la función

Tabla 16. Argumentos de DesStartBrowseSession
Tipo de datos Argumento Uso Descripción
DESBROWSEINFO BrowseInfo entrada Puntero para la información necesario para examinar y resaltar las coincidencias de un documento de texto. El puntero lo devuelve DesGetSearchResultTable o DesGetBrowseInfo.
char * pUserId entrada ID de usuario para la base de datos
DESSMALLINT UserIdLength entrada Longitud del ID de usuario para la base de datos
char * pPassword entrada Contraseña para la base de datos
DESSMALLINT PasswordLength entrada Longitud de la contraseña para la base de datos
DESBROWSESESSION * pBrowseSession salida Un descriptor de contexto para una sesión de examen para que la utilicen otras funciones de examen.
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

Esta función abre una sesión de examen para examinar documentos de texto. Se le solicita el ID de usuario y la contraseña para comprobar la autorización para acceder a la base de datos.

La sesión de examen se cierra llamando a DesEndBrowseSession.

BrowseInfo depende del argumento de búsqueda y de la columna de texto base utilizada para crear la información de examen.

Códigos de retorno

RC_SUCCESS
 
RC_ALLOCATION_ERROR
RC_INVALID_BROWSE_INFO
RC_INVALID_PARAMETER
RC_INTERNAL_ERROR
RC_SE_NOT_ENOUGH_MEMORY
RC_SE_UNEXPECTED_ERROR
RC_SQL_ERROR_NO_INFO
RC_SQL_ERROR_WITH_INFO

Restricciones

Debe llamar a DesGetBrowseInfo o DesGetSearchResultTable con la opción de examen adecuada antes de llamar a esta función.


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