Interstage List Works V11.0.0 APIリファレンス

1.4.5 LW_StartKeepList(保管フォルダ内の帳票一覧開始)

記述形式

LWLISTHANDLE  LW_StartKeepList(LWAPIHANDLE   iServerApiHandle,
                               char *        lpKeepFolder)

機能

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

パラメタの説明

iServerApiHandle

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

lpKeepFolder

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

復帰値

0以外

正常終了しました。

この復帰値が帳票一覧識別子になります。

0

異常終了しました。

注意

• 指定された保管フォルダにある帳票数、帳票一覧などの情報を取得する前に必ず、一度本APIを実行してください。

• 本APIを実行したあと、帳票一覧の処理が完了したら、必ず、LW_EndKeepList(保管フォルダ内の帳票一覧終了)を実行してください。LW_EndKeepList(保管フォルダ内の帳票一覧終了)を実行しないと、領域が解放されない場合があります。

  また、本APIを一度実行した場合、LW_EndKeepList(保管フォルダ内の帳票一覧終了)を実行しないで再度本APIを実行すると、エラーになります。

参考

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

エラーコードの取得

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

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

エラーメッセージの取得

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

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