目的
接收搜尋引數,以搜尋 handle 所識別的所有文字。 它會傳回指標,指向 DesStartBrowseSession 所需的瀏覽資訊,以強調顯示所找到的術語。
語法
DESRETURN DesGetBrowseInfo (SQLHDBC hdbc, SQLCHAR *pHandle, DESUSHORT HandleLength, char *pSearchArgument, DESSMALLINT ArgumentLength, DESBROWSEINFO *pBrowseInfo, DESMESSAGE *pErrorMessage);
函數引數
資料 類型 | 引數 | 使用 | 說明 |
---|---|---|---|
SQLHDBC | hdbc | 輸入 | 資料庫連接 handle。 |
SQLCHAR * | pHandle | 輸入 | 指向已從資料庫取出之 handle 的指標。 |
DESUSHORT | HandleLength | 輸入 | pHandle 的長度。DES_NTS 無法在此處使用。 |
char * | pSearchArgument | 輸入 | 一種指標,指向用來指定您要尋找之資訊的文字搜尋引數。 |
DESSMALLINT | ArgumentLength | 輸入 | 若非 pSearchArgument 的長度 (不包括空位元組終止符),即為 DES_NTS。 |
DESBROWSEINFO * | pBrowseInfo | 輸出 | 指向包含瀏覽文字文件所需之瀏覽資訊的指標。 這個指標會被傳遞到 DesStartBrowseSession。 |
DESMESSAGE * | pErrorMessage | 輸出 | 執行時所定義的訊息文字。如果發生錯誤,DB2 Text Extender 會傳回錯誤碼及錯誤訊息。 應用程式會依 DES_MAX_MESSAGE_LENGTH 的大小配置該緩衝區。 如果 pErrorMessage 是 NULL 指標, 不會傳回任何錯誤訊息。 |
用法
您的應用程式必須先與資料庫建立連線,才能呼叫 DesGetBrowseInfo。
就指向搜尋引數的指標而言,會使用 char*, 而不是使用 SQLCHAR*。 這是因為參數值有可能不是來自資料庫。
欲取得 SQL 資料類型及 C 資料類型之間的對映, 您必須使用 SQL 代號名稱 SQL_VARBINARY,以取得 handle。 指向 Handle 值之 C 陳述的主變數類型為 SQLCHAR*。
DB2 Text Extender 會為瀏覽資訊配置儲存體。 應用程式必須呼叫 DesFreeBrowseInfo 來釋放儲存體及相關資源。
因為 Handle 值為位元資料,且包含數個 '\0' 字元,所以您必須指定 pHandle 的長度。
pSearchArgument 中的搜尋引數說明於搜尋引數的語法。
回覆碼
限制
只有在您已連接資料庫,並且使用 DB2 Text Extender 函數從資料庫中取出一個 handle 之後, 才能夠呼叫此函數。