1.4.4 LW_GetKeepFolderItem(保管フォルダ一覧取得)

記述形式

int  LW_GetKeepFolderItem(LWAPIHANDLE      iServerApiHandle,
                          LWFOLDERHANDLE   iStartKeepFolderHandle,
                          int              iKeepFolderIndex,
                          LPKPFINFO        lpKPFInfo)

機能

保管フォルダの一覧情報を取得します。

パラメタの説明

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

iStartKeepFolderHandle: 保管フォルダ一覧識別子を指定します。

iKeepFolderIndex

取得したい保管フォルダが格納されているインデックスを0から「保管フォルダ数 - 1」までの数値で指定します。

範囲外の値を指定した場合、エラーになります。

lpKPFInfo

保管フォルダの一覧情報を取得するKPFINFO構造体 (保管フォルダ情報構造体)のアドレスを指定します。

保管フォルダ一覧情報の領域は、呼び出し元で獲得してください。

KPFINFO構造体の「usf_Length」は、必ず指定してください。KPFINFO構造体の「usf_Length」を指定しないと、エラーになります。

KPFINFO構造体を、以下に示します。

typedef struct KeepFolderInfo
{
unsigned short usf_Length;              /*領域長                    */
char           cf_Rsv1[2];              /*リザーブ                  */
unsigned short usf_NestLevel;           /*保管フォルダの階層        */
char           cf_Rsv2[2];              /*リザーブ                  */
char           cf_Name[128 + 4];        /*保管フォルダ名            */
char           cf_PathName[260 + 4];    /*保管フォルダの論理パス名  */
char           cf_Rsv3[108];            /*リザーブ                  */
} KPFINFO;
typedef   KPFINFO*   LPKPFINFO;

KPFINFO構造体の説明

メンバ変数	項目	説明
usf_Length	領域長	構造体のサイズを指定します。本APIを実行する前に、呼び出し元でsizeof(KPFINFO)を実行してください。
cf_Rsv1	リザーブ	－
usf_NestLevel	保管フォルダの階層	保管フォルダの階層の番号が設定されます。最上位の保管フォルダは、「0」となります。
cf_Rsv2	リザーブ	－
cf_Name	保管フォルダ名	保管フォルダ名が設定されます。
cf_PathName	保管フォルダの論理パス名	保管フォルダの論理パスが設定されます。
cf_Rsv3	リザーブ	－

復帰値

0: 正常終了しました。

-1: 異常終了しました。

参考

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

エラーコードの取得

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

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

エラーメッセージの取得

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

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