Documentation
(C) IBM Corp. 1996, 2000

DB2 Text Extender Administración y programación

DesOpenDocument

Finalidad

Recibe un puntero de sesión de examen, un descriptor de contexto y una opción (DES_EXTENDED o DES_FAST) que indica si el documento de texto debe analizarse con o sin la utilización de un diccionario. Prepara el documento de texto que corresponde al descriptor de contexto para obtener el texto del documento y la información de resaltado y devuelve un descriptor de contexto de documento que se utiliza para llamar iterativamente a DesGetMatches.

Sintaxis

DESRETURN
  DesOpenDocument
    (DESBROWSESESSION    BrowseSession,
     SQLCHAR             *pHandle,
     DESUSHORT           HandleLength,
     DESMATCHMODE        MatchMode,
     DESHANDLE           *pDocumentHandle,
     DESMESSAGE          *pErrorMessage);

Argumentos de la función

Tabla 15. Argumentos de DesOpenDocument
Tipo de datos Argumento Uso Descripción
DESBROWSESESSION BrowseSession entrada Descriptor de contexto de sesión de examen.
SQLCHAR * pHandle entrada Puntero para el descriptor de contexto extraído de la base de datos.
DESUSHORT HandleLength entrada Longitud de pHandle (no se puede utilizar DES_NTS).
DESMATCHMODE MatchMode entrada Modalidad para determinar si se utiliza un diccionario para buscar la información de resaltado.

DES_FAST
No utilizar un diccionario

DES_EXTENDED
Utilizar un diccionario
DESHANDLE * pDocumentHandle salida Un descriptor de contexto de documento para llamar iterativamente a DesGetMatches.
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

DES_FAST y DES_EXTENDED hacen referencia al uso del proceso lingüístico para buscar los términos que se han de resaltar en el texto examinado. Consulte el apartado Proceso lingüístico para examen para obtener más información. Especifique DES_FAST para utilizar el análisis de texto básico y DES_EXTENDED para utilizar la comparación ampliada.

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 apuntan a la representación C de valores TextHandle es SQLCHAR*.

DB2 Text Extender asigna el almacenamiento para la información de examen. El programa de aplicación debe liberar este almacenamiento y los recursos relacionados llamando a DesFreeBrowseInfo.

Puesto que los valores de TextHandle son datos de bits y contienen varios caracteres '\0', debe especificar la longitud de pHandle.

El llamante debe tener acceso de lectura para la tabla que contiene el documento de texto al que pHandle hace referencia.

Códigos de retorno

RC_SUCCESS
 
RC_ALLOCATION_ERROR
RC_INTERNAL_ERROR
RC_INVALID_MATCH_OPTION
RC_INVALID_PARAMETER
RC_INVALID_SESSION
RC_SE_DOCUMENT_NOT_ACCESSIBLE
RC_SE_DOCUMENT_NOT_FOUND
RC_SE_INCORRECT_HANDLE
RC_SE_IO_PROBLEM
RC_SE_LS_FUNCTION_FAILED
RC_SE_LS_NOT_EXECUTABLE
RC_SE_MAX_NUMBER_OF_BUSY_INDEXES
RC_SE_NOT_ENOUGH_MEMORY
RC_SE_REQUEST_IN_PROGRESS
RC_SE_UNKNOWN_INDEX_NAME
RC_SE_UNEXPECTED_ERROR

Restricciones

Sólo puede llamarse a esta función después de haber iniciado una sesión de examen llamando a DesStartBrowseSession.


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