F.2.2 取得関数（KVRDIC_get_dicinfo

機能

指定されたハンドルに対する辞書情報を取得します。

書式

int KVRDIC_get_dicinfo_list(void *ghandle, void *dicinfo);

パラメタ

void *	ghandle	(in)	辞書情報一覧取得用ハンドル
void *	dicinfo	(out)	辞書情報一覧からの未返却の情報

戻り値

戻り値	意味
0	辞書情報の取得が正常に行われた場合に返却します。
10	指定されたハンドルに対する辞書情報一覧に返却すべき未返却情報がない、すなわち辞書情報一覧からすべての情報を返却した場合に返します。この場合、dicinfoに辞書情報を返却する必要はありません。
それ以外	何らかの原因でハンドルの取得に失敗した場合に返却します。

説明

ghandleには、辞書情報一覧を取得する対象のハンドルが渡されます。

dicinfoには、指定されたハンドルに対する辞書情報一覧から未返却の情報を返却してください。返却する辞書情報は、ハンドル取得の際に指定された辞書種別に対応した以下の構造体の形式で、dicinfoで渡されたアドレスに書き込んでください。

KVRDIC_STRUCT_CLOSEINFO：公開/非公開情報

公開/非公開情報構造体

辞書出口モジュールに必要な構造体については、“取得開始関数（KVRDIC_open_dicinfo_list）”の“公開/非公開情報構造体”を参照してください。

注意事項

公開/非公開情報を作成する上での注意点については、“取得開始関数（KVRDIC_open_dicinfo_list）”の“注意事項”を参照してください。

サンプルプログラム

===================================================================================
#include <stdlib.h>
#include "kvrdic_dicexit.h"
/* ハンドル構造体 */
typedef struct{
      int info_num;
      int count;
      KVRDIC_STRUCT_CLOSEINFO *info;
}SampleHandle;
/**************************/
/* 辞書情報の取得関数     */
/**************************/
int KVRDIC_get_dicinfo_list(void *ghandle, void *dicinfo)
{
      SampleHandle *hp;
      KVRDIC_STRUCT_CLOSEINFO *out;
      /*****     inパラメタチェック    *****/
      /* 何らかの原因で辞書情報の取得に失敗した場合はrc!=0or10で終了する */ 
      if (ghandle==NULL || dicinfo==NULL) return 1;
      hp=ghandle;
      out=dicinfo;
      /* 返却すべき情報がもう無い場合はrc=10で終了する */ 
      if (hp->info_num <= hp->count ) return 10;
      /*****      outパラメタ設定      *****/
      *out = (hp->info)[hp->count];
      hp->count ++;
      /* 処理が正常終了した場合はrc=0で終了する */
      return 0;
}
===================================================================================

F.2.2 取得関数（KVRDIC_get_dicinfo_list）