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:
Los elementos de corriente de datos tienen cada uno dos bytes de longitud. Son:
El texto utiliza el CCSID y el idioma asociado al párrafo actual.
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.
Uso
DesGetMatches devuelve RC_SE_END_OF_INFORMATION cuando se alcanza el final del documento de texto.
Códigos de retorno
Restricciones
Sólo puede llamarse a esta función después de haber abierto un documento de texto llamando a DesOpenDocument.