Documentation
(C) IBM Corp. 1996, 2000

DB2 Text Extender

DesStartBrowseSession

目的

啟動瀏覽階段作業,建立瀏覽文字文件及強調顯示其相符者所需的環境。 它會接收指向瀏覽資訊的指標 (接收來源可能是 DesGetBrowseInfo 或 DesGetSearchResultTable), 並且會傳回要供其它瀏覽函數使用的瀏覽階段作業 handle。

語法

DESRETURN
  DesStartBrowseSession
     (DESBROWSEINFO        BrowseInfo,
      char                 *pUserId,
      DESSMALLINT           UserIdLength,
      char                 *pPassword,
      DESSMALLINT           PasswordLength,
      DESBROWSESESSION     *pBrowseSession,
     DESMESSAGE          *pErrorMessage);

函數引數

表 16. DesStartBrowseSession 引數
資料 類型 引數 使用 說明
DESBROWSEINFO BrowseInfo 輸入 一種指標,指向在文字文件中瀏覽及強調顯示相符者時所需的資訊。 此指標是由 DesGetSearchResultTable 或 DesGetBrowseInfo 所傳回。
char * pUserId 輸入 資料庫的使用者 ID
DESSMALLINT UserIdLength 輸入 資料庫使用者 ID 的長度
char * pPassword 輸入 資料庫的通行碼
DESSMALLINT PasswordLength 輸入 資料庫通行碼的長度
DESBROWSESESSION * pBrowseSession 輸出 可供其它瀏覽函數使用的瀏覽階段作業的 handle。
DESMESSAGE * pErrorMessage 輸出 執行時所定義的訊息文字。如果發生錯誤,DB2 Text Extender 會傳回錯誤碼及錯誤訊息。 應用程式會依 DES_MAX_MESSAGE_LENGTH 的大小配置該緩衝區。 如果 pErrorMessage 是 NULL 指標, 不會傳回任何錯誤訊息。

用法

此函數可開啟瀏覽階段作業,以瀏覽文字文件。 您會被提示輸入您的使用者 ID 和通行碼,以檢查您對此資料庫的存取權限。

您可呼叫 DesEndBrowseSession 來關閉瀏覽階段作業。

BrowseInfo 取決於搜尋引數及用來建置瀏覽資訊的基本文字直欄。

回覆碼

RC_SUCCESS
 
RC_ALLOCATION_ERROR
RC_INVALID_BROWSE_INFO
RC_INVALID_PARAMETER
RC_INTERNAL_ERROR
RC_SE_NOT_ENOUGH_MEMORY
RC_SE_UNEXPECTED_ERROR
RC_SQL_ERROR_NO_INFO
RC_SQL_ERROR_WITH_INFO

限制

在呼叫此函數之前,您必須用適當的「瀏覽選項」來呼叫 DesGetBrowseInfo 或 DesGetSearchResultTable。


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