7.25.1. 概要¶
7.25.1.1. 概要¶
Groongaをライブラリーとして使うことができます。Groongaを初期化・終了するために次のAPIを使う必要があります。
grn_init()
はGroongaを初期化します。一方、 grn_fin()
はGroongaを終了します。
Groongaが提供するAPIを使う前に grn_init()
を1度だけ呼ぶ必要があります。Groongaが提供するAPIを呼び終わったら、 grn_fin()
を1度だけ呼ぶ必要があります。
7.25.1.2. 例¶
以下はGroongaを全文検索ライブラリーとして使う例です。
grn_rc rc;
/* It initializes resources used by Groonga. */
rc = grn_init();
if (rc != GRN_SUCCESS) {
return EXIT_FAILURE;
}
/* Some Groonga API calling codes... */
/* It releases resources used by Groonga. */
grn_fin();
return EXIT_SUCCESS;
7.25.1.3. リファレンス¶
-
grn_rc grn_init(void)¶
grn_init()
はGroongaが使うリソースを初期化します。他のGroongaのAPIを呼ぶ前に1度だけこれを呼ぶ必要があります。- 戻り値:
成功時は
GRN_SUCCESS
、エラー時はGRN_SUCCESS
以外。
-
grn_rc grn_fin(void)¶
grn_fin()
はGroongaが使ったリソースを解放します。grn_fin()
を呼んだ後はGroongaのAPIを呼ぶことはできません。- 戻り値:
成功時は
GRN_SUCCESS
、エラー時はGRN_SUCCESS
以外。