Documentation
(C) IBM Corp. 1996, 2000

DB2 Text Extender Administración y programación

DesGetMatches

Finalidad

Devuelve una corriente de datos que contiene información de resaltado para el documento de texto descrito por un descriptor de contexto de documento. Consulte el apartado Sintaxis de la corriente de datos. La información de resaltado comprende el contexto del texto (un párrafo como mínimo) y la información para resaltar el texto en ese contexto.

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 RC_SE_END_OF_INFORMATION.

Sintaxis

DESRETURN
  DesGetMatches
     (DESBROWSESESSION    BrowseSession,
      DESHANDLE           DocumentHandle,
      DESMATCHINFO        *pMatchInfo,
      DESULONG            *pMatchInfoLength,
      DESMESSAGE          *pErrorMessage);

Argumentos de la función

Tabla 13. Argumentos DesGetMatches
Tipo de datos Argumento Uso Descripción
DESBROWSESESSION BrowseSession entrada Descriptor de contexto de sesión de examen.
DESHANDLE DocumentHandle entrada Descriptor de contexto de documento devuelto por DesOpenDocument.
DESMATCHINFO * pMatchInfo salida Puntero para un almacenamiento intermedio que contiene la parte de la corriente de datos recibida. DesGetMatches asigna ese almacenamiento intermedio.
DESULONG * pMatchInfoLength salida La longitud de la parte de la corriente de datos a la que apunta pMatchInfo.
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.

Sintaxis de la corriente de datos

>>- --05-- --DB2TX_DOC-- --DB2TX_START-- ----------------------->
 
>-----+----------------------------------------------------------------+>
      '- --ll-- --DB2TX_DNAM-- --DB2TX_ATOMIC-- --nombre_documento-- --'
 
      .----------------.
      V                |
>--------| Sección |---+-- --05-- --DB2TX_DOC-- --DB2TX_END-- --><
 
Sección
 
|--- --05-- --DB2TX_DEL-- --DB2TX_START-- ---------------------->
 
>-----+--------------------------------------------------------------+>
      '- --ll-- --DB2TX_SNAM-- --DB2TX_ATOMIC-- --nombre_sección-- --'
 
      .-------------------------------------------------.
      |                             .----------------.  |
      V                             V                |  |
>--------| Codificación de texto |-----| Párrafo |---+--+------->
 
>---- --05-- --DB2TX_DEL-- --DB2TX_END-- -----------------------|
 
Codificación de texto
 
|--- --07-- --DB2TX_CCSID-- --DB2TX_ATOMIC-- --identificador_juego_caracteres_codificado-- -->
 
>--- --07-- --DB2TX_LANG-- --DB2TX_ATOMIC-- --identificador_idioma-- -->
 
>---------------------------------------------------------------|
 
Párrafo
 
|--- --05-- --DB2TX_PAR-- --DB2TX_START-- ---------------------->
 
      .-------------------------.
      V                         |
>--------| Texto de párrafo |---+------------------------------->
 
>---- --05-- --DB2TX_PAR-- --DB2TX_END-- -----------------------|
 
Texto de párrafo
 
|---+- --ll-- --DB2TX_TEXT-- --DB2TX_ATOMIC-- --unidad_texto-- --+->
    '- --ll-- --DB2TX_LINK-- --DB2TX_ATOMIC-- --cons_soporte-- --'
 
     .-----------------------------------------------.
     V                                               |
>-------+-----------------------------------------+--+---------->
        '- --05-- --DB2TX_NL-- --DB2TX_ATOMIC-- --'
 
      .-------------------------------------------------------------------------------.
      V                                                                               |
>--------+-------------------------------------------------------------------------+--+>
         '- --ll-- --DB2TX_MATCH-- --DB2TX_ATOMIC-- --información_coincidencia-- --'
 
>---------------------------------------------------------------|
 

 

Cada segmento de un diagrama de sintaxis como, por ejemplo, 05 DB2TX_DOC DB2TX_START, empieza por un campo de longitud de tipo entero, que en el diagrama es un número explícito como 05 o una variable ll. La longitud del segmento incluye el campo de longitud de 2 bytes.
Nota:La longitud está en formato big-endian.

Cada segmento incluye uno de los siguientes identificadores de tipo de 1 byte:

DB2TX_START
Indica el inicio de un segmento como, por ejemplo, un documento o un párrafo.

DB2TX_END
Indica el final de un segmento.

DB2TX_ATOMIC
Indica que el elemento que sigue es de átomo como, por ejemplo, un nombre de documento o un identificador de idioma.

Los elementos de corriente de datos tienen cada uno dos bytes de longitud. Son:

DB2TX_DOC
Indica el inicio y el final de un documento.

DB2TX_DNAM
Un nombre de documento. Si no se especifica ningún nombre, se utiliza el identificador del documento.

DB2TX_DEL
Indica el inicio y el final de un elemento de documento. El único tipo de elemento de documento actualmente soportado es una sección de texto.

DB2TX_SNAM
Especifica el nombre de una sección de texto. Actualmente, DB2 Text Extender soporta una sola sección de texto y suministra automáticamente un nombre por omisión. Si especifica un nombre de sección, se pasa por alto.

DB2TX_PAR
Indica el inicio y el final de un párrafo de texto dentro de la sección actual.

DB2TX_TEXT
Especifica una parte de texto dentro del párrafo actual. Normalmente, la unidad de texto contiene una línea de texto y el elemento TEXT va seguido por un elemento DB2TX_NL; pero las líneas de texto también se pueden dividir en varias partes, cada una especificada en su propio elemento DB2TX_TEXT.

El texto utiliza el CCSID y el idioma asociado al párrafo actual.

DB2TX_LINK
Especifica una consulta hipermedia de DB2 Text Extender. Utiliza el CCSID del párrafo actual.

DB2TX_NL
Indica el inicio de una nueva línea del párrafo actual.

DB2TX_MATCH
Contiene la información de apariciones de las coincidencias en la parte de texto actual. La información se suministra como una secuencia de pares de números binarios. El primer número de cada par es el desplazamiento de una coincidencia en la parte de texto actual, el segundo número es la longitud en caracteres de esa coincidencia. La longitud dada podría exceder de la parte de texto dada. Tanto el desplazamiento como la longitud son valores de dos bytes especificados en formato big-endian.

DB2TX_CCSID
El CCSID para el texto de los párrafos posteriores hasta que un párrafo vaya precedido por un nuevo elemento DB2TX_CCSID. Se devuelven los siguientes CCSID:

DB2TX_CCSID_00500
para el texto en la página de códigos 500 de EBCDIC Latin-1.

DB2TX_CCSID_04946
para el texto en la página de códigos 850 de ASCII Latin-1.

DB2TX_CCSID_00819
para el texto en la página de códigos 819 de ASCII.

Esos nombres simbólicos para los CCSID se definen en el archivo DES_EXT.H proporcionado por DB2 Text Extender. Los valores binarios de dos bytes se especifican en formato big-endian.

DB2TX_LANG
El identificador del idioma para el texto de los párrafos posteriores hasta que un párrafo vaya precedido por un nuevo elemento DB2TX_LANG. El archivo DES_EXT.H proporcionado con DB2 Text Extender define nombres simbólicos para todos los identificadores soportados por DB2 Text Extender. Los valores binarios de dos bytes se especifican en formato big-endian.

Uso

DesGetMatches devuelve RC_SE_END_OF_INFORMATION cuando se alcanza el final del documento de texto.

Códigos de retorno

RC_SUCCESS
RC_SE_END_OF_INFORMATION
 
RC_INVALID_PARAMETER
RC_INVALID_SESSION
RC_SE_CAPACITY_LIMIT_EXCEEDED
RC_SE_INCORRECT_HANDLE
RC_SE_IO_PROBLEM
RC_SE_NOT_ENOUGH_MEMORY
RC_SE_REQUEST_IN_PROGRESS
RC_SE_LS_FUNCTION_FAILED
RC_SE_UNEXPECTED_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_DICTIONARY_NOT_FOUND

Restricciones

Sólo puede llamarse a esta función después de haber abierto un documento de texto llamando a DesOpenDocument.


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