記述形式
int LW_GetKeepListItem(LWAPIHANDLE iServerApiHandle,
LWLISTHANDLE iStartKeepListHandle,
int iKeepListIndex,
LPKPLINFO lpKPLInfo)機能
帳票の一覧情報を取得します。
パラメタの説明
サーバAPI識別子を指定します。
帳票一覧識別子を指定します。
取得したい帳票が格納されているインデックスを0から「帳票数 - 1」までの数値で指定します。
範囲外の値を指定した場合、エラーになります。
帳票一覧を取得するためのKPLINFO構造体 (帳票情報構造体)のアドレスを指定します。
参照
KPLINFO構造体については、“1.4.8.1 KPLINFO構造体(帳票情報構造体)”を参照してください。
KPLINFO構造体の領域は、呼び出し元で獲得してください。
復帰値
正常終了しました。
異常終了しました。
注意
指定した保管フォルダの全帳票一覧情報を取得したい場合、インデックスを0から「帳票数 - 1」までインクリメントして、本APIを帳票数分実行してください。
参考
異常終了した場合に以下のサーバ機能APIを実行すると、エラーの詳細を取得できます。
KPLINFO構造体を、以下に示します。
注意
「usl_Length」は、必ず指定してください。「usl_Length」を指定しないとエラーになります。
KPLINFO構造体
#define LWSSAPI_COLLEN (64*4+4)
#define LWSSAPI_PATHLEN (600*8+24+4)
typedef struct KeepListInfo
{
unsigned short usl_Length; /*領域長 */
char cl_Rsv1[2]; /*リザーブ */
unsigned short usl_Rsv2; /*リザーブ */
char cl_Rsv3[2]; /*リザーブ */
char cl_Title[LWSSAPI_COLLEN]; /*帳票名 */
char cl_SubTitle[LWSSAPI_COLLEN]; /*コメント */
char cl_Comment1[LWSSAPI_COLLEN]; /*備考1 */
char cl_Comment2[LWSSAPI_COLLEN]; /*備考2 */
char cl_Comment3[LWSSAPI_COLLEN]; /*備考3 */
char cl_Comment4[LWSSAPI_COLLEN]; /*備考4 */
char cl_SplFile[LWSSAPI_PATHLEN]; /*帳票の論理パス名 */
char cl_OwnerName[LWSSAPI_COLLEN]; /*作成者名 */
char cl_AddDate[16 + 4]; /*登録日時 */
char cl_CreateDate[16 + 4]; /*作成日時 */
char cl_LastAcsDate[16 + 4]; /*最終参照日時 */
char cl_TermDate[10 + 2]; /*登録有効期限 */
char cl_LocalSave; /*リザーブ */
char cl_IndexSearch; /*抜き出し検索ファイルの有無 */
char cl_DelType; /*削除対象 */
char cl_PrtType; /*リザーブ */
char cl_MemType; /*帳票記入情報の有無 */
char cl_F66Type; /*リザーブ */
char cl_Polling; /*ポーリング印刷依頼 */
char cl_LocalPrint; /*リザーブ */
unsigned short usl_AccessNum; /*アクセス回数 */
char cl_Rsv5[2]; /*リザーブ */
unsigned long ull_AllPageNum; /*全ページ数 */
char cl_SplId[16 + 4]; /*リザーブ */
char cl_PaperOrient; /*印刷用紙の向き */
char cl_PaperSize; /*印刷用紙サイズ */
char cl_Rsv6[2]; /*リザーブ */
unsigned short usl_PrintWidth; /*印刷横倍率 */
char cl_Rsv7[2]; /*リザーブ */
unsigned short usl_PrintHeight; /*印刷縦倍率 */
char cl_Rsv8[2]; /*リザーブ */
char cl_DataSpaceType; /*印刷データの空白文字の扱い */
char cl_ShowDate[10 + 2]; /*参照有効期限 */
char cl_ShowType; /*表示対象 */
char cl_Mask; /*マスク文字の有無 */
char cl_NForm; /*二次帳票の作成可否 */
char cl_Rsv; /*リザーブ */
char cl_Rsv9[139]; /*リザーブ */
} KPLINFO;
typedef KPLINFO* LPKPLINFO;KPLINFO構造体の各項目を説明します。
メンバ変数 | 項目 | 説明 |
|---|---|---|
usl_Length | 領域長 | 構造体のサイズを指定します。 本APIを実行する前に、呼び出し元でsizeof(KPLINFO)を実行してください。 |
cl_Rsv1 | リザーブ | － |
usl_Rsv2 | リザーブ | － |
cl_Rsv3 | リザーブ | － |
cl_Title | 帳票名 | 帳票名が設定されます。 |
cl_SubTitle | コメント | コメントが設定されます。 |
cl_Comment1 | 備考1 | 備考1が設定されます。 |
cl_Comment2 | 備考2 | 備考2が設定されます。 |
cl_Comment3 | 備考3 | 備考3が設定されます。 |
cl_Comment4 | 備考4 | 備考4が設定されます。 |
cl_SplFile | 帳票の論理パス名 | 帳票の論理パス名が設定されます。 |
cl_OwnerName | 作成者名 | 作成者名が設定されます。 |
cl_AddDate | 登録日時 | 登録日時が設定されます。 |
cl_CreateDate | 作成日時 | 作成日時が設定されます。 |
cl_LastAcsDate | 最終参照日時 | 最終参照日時が設定されます。 |
cl_TermDate | 登録有効期限 | 登録有効期限が設定されます。 |
cl_LocalSave | リザーブ | － |
cl_IndexSearch | 抜き出し検索ファイルの有無 | 抜き出し検索ファイルの有無が設定されます。 0：無 1：有 |
cl_DelType | 削除対象 | 削除対象が設定されます。 0：有効期限を過ぎても削除対象としない 1：有効期限を過ぎたら削除対象とする |
cl_PrtType | リザーブ | － |
cl_MemType | 帳票記入情報の有無 | 帳票記入情報の有無が設定されます。 0：無 1：有 |
cl_F66Type | リザーブ | － |
cl_Polling | ポーリング印刷依頼 | ポーリング印刷依頼が設定されます。 0：印刷未 1：印刷済 |
cl_LocalPrint | リザーブ | － |
usl_AccessNum | アクセス回数 | アクセス回数が設定されます。 |
cl_Rsv5[2] | リザーブ | － |
ull_AllPageNum | 全ページ数 | 全ページ数が設定されます。 |
cl_SplId[16+4] | リザーブ | － |
cl_PaperOrient | 印刷用紙の向き | 印刷する時の印刷用紙の向きが設定されます。 0：指定なし 1：ポートレート 2：ランドスケープ |
cl_PaperSize | 印刷用紙サイズ | 印刷用紙サイズが設定されます。 0：指定なし 1：Letter 8 1/2 × 11 インチ 5：Legal 8 1/2 × 14 インチ 8：A3 297 × 420 mm 9：A4 210 × 297 mm 11：A5 148 × 210 mm 12：B4 (JIS) 250 × 354 13：B5 (JIS) 182 × 257 mm 43：Japanese Postcard 100 × 148 mm 66：A2 420 × 594 mm 70：A6 105 × 148 mm |
cl_Rsv6[2] | リザーブ | － |
usl_PrintWidth | 印刷横倍率 | 印刷横倍率(%)が設定されます。 |
cl_Rsv7[2] | リザーブ | － |
usl_PrintHeight | 印刷縦倍率 | 印刷縦倍率(%)が設定されます。 |
cl_Rsv8[2] | リザーブ | － |
cl_DataSpaceType | 印刷データの空白文字の扱い | 印刷データの空白文字（全角文字、半角文字）の扱いが設定されます。 0：空白文字は無視する 1：空白文字を有効とする |
cl_ShowDate | 参照有効期限 | 参照有効期限が「YYYY/MM/DD 」の形式で1970/01/01～9999/12/31の範囲で設定されます。 |
cl_ShowType | 表示対象 | 表示対象が設定されます。 0：参照有効期限を過ぎたら表示しない |
cl_Mask | マスク文字の有無 | マスク文字が存在するかどうかが設定されます。 0：マスク文字が存在しない 1：マスク文字が存在する |
cl_NForm | 二次帳票の作成可否 | 二次帳票の作成可否が設定されます。 0：作成不可 1：作成可能 |
cl_Rsv | リザーブ | － |
cl_Rsv9[139] | リザーブ | － |