Este grupo de funciones de la Figura 14 averigua los términos que se han de resaltar. Después, inicia una sesión de examen, abre un documento y obtiene la información coincidente en el formato de una corriente de datos que un programa de aplicación que llama al examinador puede analizar.
La función DesGetBrowseInfo recibe un argumento de búsqueda y un descriptor de contexto. Devuelve un puntero a la información de examen necesario para DesStartBrowseSession. La información de examen incluye una lista de todos los términos que se han de resaltar.
Otro método de obtener información de examen es especificar la opción de examinar en la función DesGetSearchResultTable.
Los parámetros de entrada son:
El descriptor de contexto para la conexión de base de datos
Un descriptor de contexto
Un argumento de búsqueda.
Esta función devuelve un puntero a la información de examen.
La función DesStartBrowseSession inicia una sesión de examen, estableciendo el entorno necesario para examinar un documento de texto y resaltando 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.
El parámetro de entrada es:
Un puntero para la información de examen de DesGetBrowseInfo o DesGetSearchResultTable
Un ID de usuario
Una contraseña.
Esta función devuelve un descriptor de contexto de sesión de examen.
La función DesOpenDocument recibe un puntero de sesión de examen, un descriptor de contexto y una opción DES_FAST o DES_EXTENDED que indica el tipo de proceso lingüístico que se ha de utilizar para resaltar los términos encontrados. Consulte la Etapa 2: Comparación ampliada. DES_FAST utiliza el análisis básico de texto, sin utilizar ningún diccionario para determinar los términos que se han de resaltar. DES_EXTENDED utiliza la comparación ampliada.
DesOpenDocument 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 del documento que se utiliza para llamar iterativamente a DesGetMatches.
Los parámetros de entrada son:
Un descriptor de contexto de sesión de examen de DesStartBrowseSession
Un descriptor de contexto de texto
Una opción de coincidencia: DES_FAST o DES_EXTENDED.
Esta función devuelve un descriptor de contexto de documento que DesGetMatches y DesCloseDocument utilizan.
La función DesGetMatches devuelve un puntero a la información de resaltado para el documento de texto descrito por un descriptor de contexto de documento. La información de resaltado es una corriente de datos. Comprende el contexto del texto (un párrafo como mínimo) e información para el resaltado de texto en ese contexto. La corriente de datos se describe en el apartado Sintaxis de la corriente de datos. Un programa de aplicación puede analizar la corriente de datos y procesarla utilizando el examinador propio del usuario.
DesGetMatches sólo devuelve una parte de la corriente de datos, indicando la longitud de la parte en la estructura de salida.
Una secuencia de llamadas a DesGetMatches obtiene todo el contenido del documento de texto. Cuando se alcanza el final del documento de texto, se devuelve un indicador.
Los parámetros de entrada son:
Un descriptor de contexto de sesión de examen
Un descriptor de contexto de documento de DesOpenDocument.
Esta función devuelve un puntero a una estructura que contiene la parte de la corriente de datos y su longitud.
La función DesCloseDocument cierra un documento de texto abierto por DesOpenDocument, y libera el almacenamiento asignado durante la devolución del texto del documento y la información de resaltado.
Los parámetros de entrada son:
Un descriptor de contexto de sesión de examen
Un descriptor de contexto de documento de DesOpenDocument.
Ninguna.
La función DesEndBrowseSession finaliza una sesión de examen iniciada por DesStartBrowseSession, y libera el almacenamiento asignado para la sesión de examen.
El parámetro de entrada es:
Un descriptor de contexto de sesión de examen.
Ninguna.
La función DesFreeBrowseInfo libera el almacenamiento asignado para la información de examen por DesGetBrowseInfo.
El parámetro de entrada es:
Un puntero para la información de examen.
Ninguna.