Documentation
(C) IBM Corp. 1996, 2000

DB2 Text Extender

DesOpenDocument

目的

接收瀏覽階段作業指標、handle 及選項 (DES_EXTENDED 或 DES_FAST), 可指示是否要使用字典來分析文字文件。它會準備與該 handle 相對符的文字文件, 以取得文件文字及強調顯示資訊,並傳回要用來反覆呼叫 DesGetMatches 的文件 handle。

語法

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

函數引數

表 15. DesOpenDocument 引數
資料 類型 引數 使用 說明
DESBROWSESESSION BrowseSession 輸入 瀏覽階段作業 handle。
SQLCHAR * pHandle 輸入 指向從資料庫取出之 handle 的指標。
DESUSHORT HandleLength 輸入 pHandle 的長度 (不能使用 DES_NTS)。
DESMATCHMODE MatchMode 輸入 用來決定是否要用字典來尋找強調顯示資訊的模式。

DES_FAST
不使用字典

DES_EXTENDED
使用字典
DESHANDLE * pDocumentHandle 輸出 文件 handle 反覆呼叫 DesGetMatches。
DESMESSAGE * pErrorMessage 輸出 執行時所定義的訊息文字。如果發生錯誤,DB2 Text Extender 會傳回錯誤碼及錯誤訊息。 應用程式會依 DES_MAX_MESSAGE_LENGTH 的大小配置該緩衝區。 如果 pErrorMessage 是 NULL 指標, 不會傳回任何錯誤訊息。

用法

DES_FAST 及 DES_EXTENDED 參照語言處理程序的使用, 可在所瀏覽的文字中尋找要強調顯示的術語。 相關資訊,請參閱瀏覽的語言處理程序。指定 DES_FAST,以使用基本文字分析,並指定 DES_EXTENDED,以使用擴充配對。

欲取得 SQL 資料類型及 C 資料類型之間的對映, 您必須使用 SQL 代號名稱 SQL_VARBINARY,以取得 handle。 指向 TextHandle 值之 C 陳述的主變數類型為 SQLCHAR*。

DB2 Text Extender 會為瀏覽資訊配置儲存體。 應用程式必須呼叫 DesFreeBrowseInfo 來釋放此儲存體及相關資源。

因為 TextHandle 值為位元資料,且包含數個 '\0' 字元,所以您必須指定 pHandle 的長度。

呼叫程式必須要有包含 pHandle 所參照之文字文件表格的讀取權。

回覆碼

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

限制

只有在您呼叫 DesStartBrowseSession 來啟動瀏覽階段作業之後,才能呼叫此函數。


[ 頁面頂端 | 前一頁 | 下一頁 | 目錄 | 索引 ]