1.4.1 LW_StartKeepFolder(保管フォルダ一覧開始)

記述形式

Windows版/Solaris版の場合

int  LW_StartKeepFolder(int      iServerApiHandle,
                        char *   lpKeepFolder,
                        int      iUnderFolder)

Linux版の場合

LWFOLDERHANDLE  LW_StartKeepFolder(LWAPIHANDLE  iServerApiHandle,
                                   char *       lpKeepFolder,
                                   int          iUnderFolder)

機能

指定された保管フォルダにある保管フォルダ一覧情報取得の開始処理を行い、識別子を返します。この識別子を保管フォルダ一覧識別子と呼びます。

パラメタの説明

iServerApiHandle: サーバAPI識別子を指定します。

lpKeepFolder

保管フォルダの論理パスを指定します。本情報の最終文字にはNULLが設定されている必要があります。

本情報にNULLを指定すると、最上位の保管フォルダが対象となります。

iUnderFolder

保管フォルダ情報の取得方法を0か1の数値で指定します。

0：指定した保管フォルダ配下のすべてのフォルダ情報を返します。
1：指定した保管フォルダの子供のフォルダ情報を返します。

復帰値

0以外

正常終了しました。

この復帰値が保管フォルダ一覧識別子になります。

0: 異常終了しました。

注意

指定された保管フォルダにある保管フォルダ数、一覧などの情報を取得する前に必ず、一度本APIを実行して、保管フォルダ一覧識別子を取得してください。
本APIを実行したあと、保管フォルダ一覧の処理が完了したら、必ず、LW_EndKeepFolder(保管フォルダ一覧終了)を実行してください。LW_EndKeepFolder(保管フォルダ一覧終了)を実行しないと、領域が解放されない場合があります。
また、本APIを一度実行した場合、LW_EndKeepFolder(保管フォルダ一覧終了)を実行しないで、再度本APIを実行すると、エラーになります。

参考

異常終了した場合に以下のサーバ機能APIを実行すると、エラーの詳細を取得することができます。

エラーコードの取得

LW_GetServerApiErrCode(サーバ機能APIエラーコード取得)

LW_GetServerApiErrCodeについては、“1.3.1 LW_GetServerApiErrCode(サーバ機能APIエラーコード取得)”を参照してください。

エラーメッセージの取得

LW_GetServerApiErrMsg(サーバ機能APIエラーメッセージ取得)

LW_GetServerApiErrMsgについては、“1.3.2 LW_GetServerApiErrMsg(サーバ機能APIエラーメッセージ取得)”を参照してください。