目的
傳回一資料串流,包含文件 handle 所說明之文字文件的強調顯示資訊。 請參閱資料串流語法。 強調顯示資訊包含文字上下文 (至少一個段落) 及該上下文中的強調顯示文字資訊。
DesGetMatches 只會傳回一部份的資料串流,表示該部份在輸出結構中的長度。
呼叫 DesGetMatches 的序列可取得整個文字文件內容。 當到達文字文件的結尾時,會傳回 RC_SE_END_OF_INFORMATION。
語法
DESRETURN DesGetMatches ( DESBROWSESESSION BrowseSession, DESHANDLE DocumentHandle, DESMATCHINFO *pMatchInfo, DESULONG *pMatchInfoLength, DESMESSAGE *pErrorMessage);
函數引數
資料 類型 | 引數 | 使用 | 說明 |
---|---|---|---|
DESBROWSESESSION | BrowseSession | 輸入 | 瀏覽階段作業 handle。 |
DESHANDLE | DocumentHandle | 輸入 | DesOpenDocument 傳回的文件 handle。 |
DESMATCHINFO * | pMatchInfo | 輸出 | 指向緩衝區的指標,該緩衝區包含已接收的資料串流部份。 DesGetMatches 會配置該緩衝區。 |
DESULONG * | pMatchInfoLength | 輸出 | 為 pMatchInfo 指向的資料串流部分的長度。 |
DESMESSAGE * | pErrorMessage | 輸出 | 執行時所定義的訊息文字。如果發生錯誤,DB2 Text Extender 會傳回錯誤碼及錯誤訊息。 應用程式會依 DES_MAX_MESSAGE_LENGTH 的大小配置該緩衝區。 如果 pErrorMessage 是 NULL 指標, 不會傳回任何錯誤訊息。 |
>>- --05-- --DB2TX_DOC-- --DB2TX_START-- -----------------------> >-----+-------------------------------------------------------------+> '- --ll-- --DB2TX_DNAM-- --DB2TX_ATOMIC-- --document_name-- --' .----------------. V | >--------| Section |---+-- --05-- --DB2TX_DOC-- --DB2TX_END-- -->< Section |--- --05-- --DB2TX_DEL-- --DB2TX_START-- ----------------------> >-----+------------------------------------------------------------+> '- --ll-- --DB2TX_SNAM-- --DB2TX_ATOMIC-- --section_name-- --' .-------------------------------------------. | .------------------. | V V | | >--------| Text encoding |-----| Paragraph |---+--+-------------> >---- --05-- --DB2TX_DEL-- --DB2TX_END-- -----------------------| Text encoding |--- --07-- --DB2TX_CCSID-- --DB2TX_ATOMIC-- --coded_character_set_identifier-- --> >--- --07-- --DB2TX_LANG-- --DB2TX_ATOMIC-- --language_identifier-- --> >---------------------------------------------------------------| Paragraph |--- --05-- --DB2TX_PAR-- --DB2TX_START-- ----------------------> .-----------------------. V | >--------| Paragraph text |---+---------------------------------> >---- --05-- --DB2TX_PAR-- --DB2TX_END-- -----------------------| Paragraph text |---+- --ll-- --DB2TX_TEXT-- --DB2TX_ATOMIC-- --text_unit-- --+-> '- --ll-- --DB2TX_LINK-- --DB2TX_ATOMIC-- --media_ref-- --' .-----------------------------------------------. V | >--------+-----------------------------------------+--+---------> '- --05-- --DB2TX_NL-- --DB2TX_ATOMIC-- --' .------------------------------------------------------------------------. V | >--------+------------------------------------------------------------------+--+> '- --ll-- --DB2TX_MATCH-- --DB2TX_ATOMIC-- --match_information-- --' >---------------------------------------------------------------|
語法圖中的每一個區段 (如 05 DB2TX_DOC DB2TX_START), 都是以類型整數的長度欄位來作為開頭,而在語法圖中, 該整數若不是一個明確的數字 (如 05), 即為一個變數 ll。 該區段的長度包括 2 位元組的長度欄位。
註: | 該長度的格式為 big-endian。 |
每一個區段都包括下列其中一個 1 位元組的類型識別字:
資料串流項目為每二位元組長。其為:
該文字使用與現行段落相關的 CCSID 及語言。
這些 CCSID 的代號名稱皆定義於 DES_EXT.H 檔案 (隨 DB2 Text Extender 提供)。 二位元組的二進位值皆以 big-endian 格式來指定。
用法
到達文字文件的結尾時,DesGetMatche 會傳回 RC_SE_END_OF_INFORMATION。
回覆碼
限制
只有在您呼叫 DesOpenDocument 來開啟文字文件之後,才能呼叫此函數。