17 パラメータ・ブロック・リファレンス

この章では、パラメータ・ブロックのSlapi_PBlock構造体で使用可能なパラメータについて説明します。この章では、各パラメータに関連付けられたデータ型を一覧表示しています。

注意: パラメータ値を読み取るには、slapi_pblock_get()を使用します。パラメータ値を書き込むには、slapi_pblock_set()を使用します。その他の関数を使用すると、サーバーがクラッシュすることがあります。

これらのパラメータの使用方法の詳細は、「プラグインAPIガイド」とinstall-path/examples/の下のサンプル・プラグインを参照してください。

17.1 パラメータ・カテゴリ

この章では、次のようにパラメータを分類します。

表17-1 Slapi_PBlockのパラメータ・カテゴリ

カテゴリ	可能なアクセス先
アクセス・ログ	すべてのプラグイン関数
追加	事前操作および事前操作追加関数
バックエンド情報	すべてのプラグイン関数
バインド	事前操作および事後操作バインド関数
比較	事前操作および事後操作比較関数
接続情報	すべてのプラグイン関数
削除	事前操作および事後操作削除関数
ディレクトリ構成情報	すべてのプラグイン関数
拡張操作	拡張操作関数
内部操作	すべてのプラグイン関数
変更	事前操作および事後操作変更関数
操作情報	すべてのプラグイン関数
プラグイン登録	プラグイン初期化関数とこの項で指定されている特定タイプ
パスワード検証	パスワード・チェック関数とデータ
事後操作エントリ・アクセス	事後操作プラグイン関数
名前変更(RDN変更)	事前操作および事後操作RDN変更関数
結果	すべてのプラグイン関数
検索	事前操作および事後操作検索関数

17.2 アクセス・ログ

次のパラメータによって、アクセス・ログの出力を構成できます。

表17-2 アクセス・ログのパラメータ

パラメータID	データ型	説明
SLAPI_OPERATION_NOTES	unsigned int	アクセス・ログで索引なし検索が示されることを指定するフラグ。 このパラメータをSLAPI_OP_NOTE_UNINDEXEDに設定すると、文字列Notes=Uが、索引なし検索を反映するアクセス・ログ・エントリに追加される。

17.3 追加

次のパラメータによって、パラメータ・ブロックを介してディレクトリに追加するエントリにアクセスできます。

表17-3 追加関数のパラメータ

パラメータID	データ型	説明
SLAPI_ADD_ENTRY	Slapi_Entry *	追加するエントリ
SLAPI_ADD_TARGET	char *	追加するエントリのDN

17.4 バックエンド情報

次のパラメータによって、パラメータ・ブロックを介してディレクトリ・バックエンドに関する情報にアクセスできます。

表17-4 バックエンド情報のパラメータ

パラメータID	データ型	説明
SLAPI_BACKEND	Slapi_Backend *	現在の操作を実行するバックエンド。 バックエンドが現在の操作に関連付けられていない場合は、NULLになることがある。
SLAPI_BE_LASTMOD	int	バックエンドが変更時間と変更者を追跡するかどうか。 0: 変更を追跡しない 1: 変更を追跡する
SLAPI_BE_READONLY	int	サーバー構成ファイルのnsslapd-readonlyの値。 0: バックエンドは書込み可能 1: バックエンドは読取り専用
SLAPI_BE_TYPE	char *	サーバー構成ファイルのnsslapd-databaseの値。
SLAPI_DBSIZE	unsigned int	バックエンド・データベースのサイズ(KB)。

17.5 バインド

次のパラメータによって、パラメータ・ブロックを介してバインド操作に関する情報にアクセスできます。

表17-5 バインド関数のパラメータ

パラメータID	データ型	説明
SLAPI_BIND_CREDENTIALS	struct berval *	バインド方法に応じた、パスワードまたはSASLメカニズム資格証明などのバインド・リクエスト資格証明
SLAPI_BIND_METHOD	int	使用される認証方法 LDAP_AUTH_NONE (匿名) LDAP_AUTH_SASL (SASL) LDAP_AUTH_SIMPLE (パスワード) LDAP_AUTH_SSL (証明書)
SLAPI_BIND_RET_SASLCREDS	struct berval *	クライアントに送信するSASLサーバー資格証明
SLAPI_BIND_SASLMECHANISM	char *	バインドに使用されるSASLメカニズム
SLAPI_BIND_TARGET	char *	バインドに使用されるDN

17.6 比較

次のパラメータによって、パラメータ・ブロックを介して比較で使用するエントリまたは属性にアクセスできます。

表17-6 比較関数のパラメータ

パラメータID	データ型	説明
SLAPI_COMPARE_TARGET	char *	比較で使用するエントリのDN
SLAPI_COMPARE_TYPE	char *	比較で使用する属性タイプ
SLAPI_COMPARE_VALUE	struct berval *	比較で使用する属性値

17.7 接続情報

次のパラメータによって、パラメータ・ブロックを介してクライアント接続に関する情報にアクセスできます。

表17-7 接続情報のパラメータ

パラメータID	データ型	説明
SLAPI_CLIENT_DNS	struct berval *	クライアントの完全修飾ドメイン名
SLAPI_CONN_AUTHMETHOD	char *	使用される認証方法 SLAPD_AUTH_NONE (匿名) SLAPD_AUTH_SASL (拡張可能なSASL) SLAPD_AUTH_SIMPLE (パスワード) SLAPD_AUTH_SSL (証明書)
SLAPI_CONN_CLIENTNETADDR	PRNetAddr *	クライアントのIPアドレス
SLAPI_CONN_DN	char *	現行の接続の認証されたユーザーのDN
SLAPI_CONNECTION	Slapi_Connection *	現行の接続
SLAPI_CONN_ID	int	現行の接続の識別子
SLAPI_CONN_IS_REPLICATION_SESSION	int	接続がレプリケーション用かどうか 0: False 1: True
SLAPI_CONN_IS_SSL_SESSION	int	接続がSSL経由かどうか 0: False 1: True
SLAPI_CONN_SERVERNETADDR	PRNetAddr *	クライアントの接続先のIPアドレス

17.8 削除

次のパラメータによって、パラメータ・ブロックを介して削除するエントリにアクセスできます。

表17-8 削除関数のパラメータ

パラメータID	データ型	説明
SLAPI_DELETE_TARGET	char *	削除するエントリのDN
SLAPI_ORIGINAL_TARGET	char *	削除するエントリの非正規化されたDN

17.9ディレクトリ構成情報

次のパラメータによって、パラメータ・ブロックを介してディレクトリ・インスタンスの構成に関する情報にアクセスできます。

表17-9 ディレクトリ構成情報のパラメータ

パラメータID	データ型	説明
SLAPI_ARGC	int	起動時にサーバーに渡されるコマンドライン引数の数
SLAPI_ARGV	char **	起動時にサーバーに渡されるコマンドライン引数の配列
SLAPI_CONFIG_DIRECTORY	char *	インスタンスの構成ファイルを含むファイル・システム・ディレクトリ
SLAPI_CONFIG_FILENAME	char *	dse.ldifなどの使用される構成ファイル

17.10 拡張操作

次のパラメータによって、パラメータ・ブロックを介して拡張操作に関する情報にアクセスできます。

例17-10 拡張操作のパラメータ

パラメータID	データ型	説明
SLAPI_EXT_OP_REQ_OID	char *	リクエストで指定される拡張操作のオブジェクト識別子(OID)
SLAPI_EXT_OP_REQ_VALUE	struct berval *	リクエストで指定される値
SLAPI_EXT_OP_RET_OID	char *	クライアントに戻すオブジェクト識別子(OID)
SLAPI_EXT_OP_RET_VALUE	struct berval *	クライアントに送信する値

17.11 内部操作

次のパラメータによって、パラメータ・ブロックを介して内部操作に関する情報にアクセスできます。

表17-11 内部操作のパラメータ

パラメータID	データ型	説明
SLAPI_PLUGIN_INTOP_RESULT	int	内部操作の結果コード
SLAPI_PLUGIN_INTOP_SEARCH_ENTRIES	Slapi_Entry **	内部検索で検出されるエントリの配列
SLAPI_PLUGIN_INTOP_SEARCH_REFERRALS	char **	LDAP URLフォーマットで内部検索により検出される参照の配列

17.12 変更

次のパラメータによって、パラメータ・ブロックを介して変更するエントリにアクセスできます。

表17-12 変更関数のパラメータ

パラメータID	データ型	説明
SLAPI_MODIFY_MODS	LDAPMod **	ターゲット・エントリで実行する変更を含むLDAPMod構造体のNULL終了配列
SLAPI_MODIFY_TARGET	char *	変更するエントリのDN
SLAPI_ORIGINAL_TARGET	char *	変更するエントリの非正規化されたDN

17.13 操作情報

次のパラメータによって、パラメータ・ブロックを介して現在の操作に関する情報にアクセスできます。

表17-13 操作情報のパラメータ

パラメータID	データ型	説明
SLAPI_CONTROLS_ARG	LDAPControl **	操作が作成される前に渡されるコントロールの配列
SLAPI_IS_INTERNAL_OPERATION	int	操作が内部的なものか、クライアント・リクエストの結果かどうか 0: クライアント・リクエスト 1: 内部操作
SLAPI_IS_REPLICATED_OPERATION	int	操作が別のサーバーのレプリケーションの一部かどうか 0: False 1: True
SLAPI_OPERATION	Slapi_Operation *	現在進行中の操作
SLAPI_OPERATION_ID	int	操作の識別子
SLAPI_OPERATION_MSGID	long	操作のメッセージ識別子
SLAPI_OPINITIATED_TIME	time_t	サーバーが操作の処理を開始した時間
SLAPI_REQCONTROLS	LDAPControl **	リクエストで指定されたコントロールの配列
SLAPI_REQUESTOR_DN	char *	操作を要求したユーザーのDN
SLAPI_REQUESTOR_ISROOT	int	操作を要求したユーザーのバインドDNが、ルートDN(インスタンスのcn=configのnsslapd-rootdnの値)に対応するかどうか 0: False 1: True
SLAPI_TARGET_DN	char *	操作を適用するDN

17.14 プラグイン登録

次のパラメータは、プラグインとその関数をサーバーに登録するとき、およびプラグインのタイプとIDに関する情報にアクセスするときに使用します。

次の表に、すべてのタイプのプラグインにアクセス可能な情報を一覧表示します。

表17-14 プラグイン情報のパラメータ

パラメータID	データ型	説明
SLAPI_PLUGIN	void *	プラグインの内部サーバー表現。
SLAPI_PLUGIN_ARGC	int	構成エントリの引数の数。
SLAPI_PLUGIN_ARGV	char *	構成エントリの引数の配列。
SLAPI_PLUGIN_IDENTITY	void *	内部操作を処理するときにサーバーによって設定および要求されるプラグイン識別子。 これをSlapi_ComponentIdにキャストすることもある。
SLAPI_PLUGIN_PRIVATE	void *	プラグイン関数に渡すプライベート・データ。 このデータ構造体を定義する。
SLAPI_PLUGIN_TYPE	int	プラグインの構成エントリのnsslapd-pluginTypeの値に対応するプラグイン関数のタイプ。(構成エントリでは、カッコで囲んで示されているプラグイン・タイプ値を使用する。) SLAPI_PLUGIN_EXTENDEDOP (extendedop) SLAPI_PLUGIN_INTERNAL_POSTOPERATION (internalpostoperation) SLAPI_PLUGIN_INTERNAL_PREOPERATION (internalpreoperation) SLAPI_PLUGIN_LDBM_ENTRY_FETCH_STORE (ldbmentryfetchstore) SLAPI_PLUGIN_MATCHINGRULE (matchingrule) SLAPI_PLUGIN_TYPE_OBJECT (object) SLAPI_PLUGIN_PASSWDCHECK (passwordcheck) SLAPI_PLUGIN_POSTOPERATION (postoperation) SLAPI_PLUGIN_PREOPERATION (preoperation) SLAPI_PLUGIN_PWD_STORAGE_SCHEME (pwdstoragescheme) SLAPI_PLUGIN_REVER_PWD_STORAGE_SCHEME (reverpwdstoragescheme)
SLAPI_PLUGIN_VERSION	char *	プラグインでサポートされているプラグインAPIのバージョン。 SLAPI_PLUGIN_CURRENT_VERSION (現在はSLAPI_PLUGIN_VERSION_03) SLAPI_PLUGIN_VERSION_01 (3.x以上のサーバー) SLAPI_PLUGIN_VERSION_02 (4.x以上のサーバー) SLAPI_PLUGIN_VERSION_03 (5.xのサーバー)

17.15 パスワード検証

パスワード・チェック・プラグインで使用するパラメータは、次のとおりです。

表17-15 パスワード検証のパラメータ

パラメータID	データ型	説明
SLAPI_PASSWDCHECK_VALS	Slapi_Value **	チェックするパスワード値の配列。
SLAPI_PLUGIN_PASSWDCHECK_FN	void *	品質基準に対してパスワード値をチェックするためにコールされる関数。詳細は、「パスワード・チェック・プラグインが実行する必要があること」を参照。

17.16 事後操作エントリ・アクセス

事後操作プラグインで使用するパラメータは、次のとおりです。これらのパラメータによって、プラグインは操作前のエントリの状態と操作後のエントリの状態を比較できます。

表17-16 事後操作エントリ・アクセスのパラメータ

パラメータID	データ型	説明
SLAPI_ENTRY_PRE_OP	Slapi_Entry *	操作前のディレクトリ・エントリ
SLAPI_ENTRY_POST_OP	Slapi_Entry *	操作後のディレクトリ・エントリ

17.17 起動と停止

汎用プラグイン関数を登録するパラメータは、次のとおりです。これらの関数タイプは、プラグインによって登録されることがあります。

表17-17 汎用関数の登録パラメータ

パラメータID	データ型	説明
SLAPI_PLUGIN_CLOSE_FN	void *	サーバーの停止時にコールされる関数。
SLAPI_PLUGIN_START_FN	void *	サーバーの起動時にコールされる関数。2回以上コールされることがある。

17.18 拡張操作

extendedopプラグイン関数とオブジェクト識別子リストを登録するパラメータは、次のとおりです。

表17-18 拡張操作の登録パラメータ

パラメータID	データ型	説明
SLAPI_PLUGIN_EXT_OP_FN	void *	LDAP v3拡張操作のリクエストでコールされる関数
SLAPI_PLUGIN_EXT_OP_OIDLIST	char **	プラグインで処理されるオブジェクト識別子(OID)のNULL終了リスト

17.19 内部事後操作

internalpostoperationプラグイン関数を登録するパラメータは、次のとおりです。

表17-19 内部事後操作の登録パラメータ

パラメータID	データ型	説明
SLAPI_PLUGIN_INTERNAL_POST_ADD_FN	void *	内部の追加操作の完了後にコールされる関数
SLAPI_PLUGIN_INTERNAL_POST_DELETE_FN	void *	内部の削除操作の完了後にコールされる関数
SLAPI_PLUGIN_INTERNAL_POST_MODIFY_FN	void *	内部の変更操作の完了後にコールされる関数
SLAPI_PLUGIN_INTERNAL_POST_MODRDN_FN	void *	内部の名前変更(RDN変更)操作の完了後にコールされる関数

17.20 内部事前操作

internalpreoperationプラグイン関数を登録するパラメータは、次のとおりです。

表17-20 内部事前操作の登録パラメータ

パラメータID	データ型	説明
SLAPI_PLUGIN_INTERNAL_PRE_ADD_FN	void *	内部の追加操作の実行前にコールされる関数
SLAPI_PLUGIN_INTERNAL_PRE_DELETE_FN	void *	内部の削除操作の実行前にコールされる関数
SLAPI_PLUGIN_INTERNAL_PRE_MODIFY_FN	void *	内部の変更操作の実行前にコールされる関数
SLAPI_PLUGIN_INTERNAL_PRE_MODRDN_FN	void *	内部の名前変更(RDN変更)操作の実行前にコールされる関数

17.21 エントリの格納と取得

ldbmentryfetchstoreプラグイン関数を登録するパラメータは、次のとおりです。

表17-21 エントリ・ストア/フェッチ関数の登録パラメータ

パラメータID	データ型	説明
SLAPI_PLUGIN_ENTRY_FETCH_FUNC	void *	バックエンドからエントリを取得するときにコールされる関数
SLAPI_PLUGIN_ENTRY_STORE_FUNC	void *	バックエンドを介してエントリを格納する前にコールされる関数

17.22 一致ルール

matchingruleプラグイン関数と引数を登録するパラメータは、次のとおりです。

表17-22 一致ルール関数および引数の登録パラメータ

パラメータID	データ型	説明
SLAPI_MATCHINGRULE_DESC	-	slapi_matchingrule_set()を使用して一致ルールの説明を登録することを示すために使用される。
SLAPI_MATCHINGRULE_NAME	-	slapi_matchingrule_set()を使用して一致ルールの名前を登録することを示すために使用される。
SLAPI_MATCHINGRULE_OBSOLETE	-	slapi_matchingrule_set()を使用して登録するときに、一致ルールが廃止されたことを示すために使用される。
SLAPI_MATCHINGRULE_OID	-	slapi_matchingrule_set()を使用して一致ルール・オブジェクト識別子を登録することを示すために使用される。
SLAPI_MATCHINGRULE_SYNTAX	-	slapi_matchingrule_set()を使用して一致ルール構文を登録することを示すために使用される。
SLAPI_PLUGIN_DESTROY_FN	void *	フィルタ・オブジェクトに割り当てられたメモリーを解放するためにコールされる関数。
SLAPI_PLUGIN_MR_FILTER_CREATE_FN	void *	フィルタ・ファクトリ関数。
SLAPI_PLUGIN_MR_FILTER_INDEX_FN	void *	インデクサ関数を設定するためにコールされる関数。
SLAPI_PLUGIN_MR_FILTER_MATCH_FN	void *	一致をチェックするためにコールされる関数。
SLAPI_PLUGIN_MR_FILTER_RESET_FN	void *	一致フィルタをリセットするためにコールされる関数。
SLAPI_PLUGIN_MR_FILTER_REUSABLE	unsigned int	フィルタが再利用可能かどうか。 0: False 1: True
SLAPI_PLUGIN_MR_INDEXER_CREATE_FN	void *	索引ファクトリ関数。
SLAPI_PLUGIN_MR_INDEX_FN	void *	単一エントリに索引を付けるためにコールされる関数。
SLAPI_PLUGIN_MR_KEYS	struct berval **	属性値に対応する索引キーの配列。
SLAPI_PLUGIN_MR_OID	char *	拡張可能な一致ルールに対応するオブジェクト識別子(OID)。
SLAPI_PLUGIN_MR_QUERY_OPERATOR	int	一致のチェックに使用される演算子のタイプ。 SLAPI_OP_EQUAL SLAPI_OP_GREATER SLAPI_OP_GREATER_OR_EQUAL SLAPI_OP_LESS SLAPI_OP_LESS_OR_EQUAL SLAPI_OP_SUBSTRING
SLAPI_PLUGIN_MR_TYPE	char *	一致ルールのフィルタ・タイプ。
SLAPI_PLUGIN_MR_USAGE	unsigned int	索引を付けるため、またはソートするためにルールを使用するかどうか。 SLAPI_PLUGIN_MR_USAGE_INDEX SLAPI_PLUGIN_MR_USAGE_SORT
SLAPI_PLUGIN_MR_VALUE	struct berval *	一致させる属性値。
SLAPI_PLUGIN_MR_VALUES	struct berval **	一致させる属性値の配列。
SLAPI_PLUGIN_OBJECT	void *	拡張可能な一致のフィルタ・オブジェクト。 このデータ構造体を定義して、一致ルール・プラグインで使用する。

17.23 事後操作

postoperationプラグイン関数を登録するパラメータは、次のとおりです。

表17-23 事後操作関数の登録パラメータ

パラメータID	データ型	説明
SLAPI_PLUGIN_POST_ABANDON_FN	void *	操作が中止された後にコールされる関数。
SLAPI_PLUGIN_POST_ADD_FN	void *	追加操作が完了した後にコールされる関数。
SLAPI_PLUGIN_POST_BIND_FN	void *	バインド操作が完了した後にコールされる関数。
SLAPI_PLUGIN_POST_COMPARE_FN	void *	比較操作が完了した後にコールされる関数。
SLAPI_PLUGIN_POST_DELETE_FN	void *	削除操作が完了した後にコールされる関数。
SLAPI_PLUGIN_POST_ENTRY_FN	void *	エントリがクライアントに送信された後にコールされる関数。
SLAPI_PLUGIN_POST_MODIFY_FN	void *	変更操作が完了した後にコールされる関数。
SLAPI_PLUGIN_POST_MODRDN_FN	void *	名前変更(RDN変更)操作が完了した後にコールされる関数。
SLAPI_PLUGIN_POST_REFERRAL_FN	void *	参照がクライアントに送信された後にコールされる関数。
SLAPI_PLUGIN_POST_RESULT_FN	void *	結果がクライアントに送信された後にコールされる関数。
SLAPI_PLUGIN_POST_SEARCH_FN	void *	検索操作が完了した後にコールされる関数。 永続的な検索操作では、この関数はクライアントが検索を中断した後にコールされる。
SLAPI_PLUGIN_POST_UNBIND_FN	void *	アンバインド操作が完了した後にコールされる関数。

17.24 事前操作

preoperationプラグイン関数を登録するパラメータは、次のとおりです。

表17-24 事前操作関数の登録パラメータ

パラメータID	データ型	説明
SLAPI_PLUGIN_PRE_ABANDON_FN	void *	操作が中止される前にコールされる関数
SLAPI_PLUGIN_PRE_ADD_FN	void *	追加操作が実行される前にコールされる関数
SLAPI_PLUGIN_PRE_BIND_FN	void *	バインド操作が実行される前にコールされる関数
SLAPI_PLUGIN_PRE_COMPARE_FN	void *	比較操作が実行される前にコールされる関数
SLAPI_PLUGIN_PRE_DELETE_FN	void *	削除操作が実行される前にコールされる関数
SLAPI_PLUGIN_PRE_ENTRY_FN	void *	エントリがクライアントに送信される前にコールされる関数
SLAPI_PLUGIN_PRE_MODIFY_FN	void *	変更操作が実行される前にコールされる関数
SLAPI_PLUGIN_PRE_MODRDN_FN	void *	名前変更(RDN変更)操作を実行する前にコールされる関数
SLAPI_PLUGIN_PRE_REFERRAL_FN	void *	参照がクライアントに送信される前にコールされる関数
SLAPI_PLUGIN_PRE_RESULT_FN	void *	結果がクライアントに送信される前にコールされる関数
SLAPI_PLUGIN_PRE_SEARCH_FN	void *	検索操作が実行される前にコールされる関数
SLAPI_PLUGIN_PRE_UNBIND_FN	void *	アンバインド操作が実行される前にコールされる関数

17.25 一方向のパスワード記憶と可逆のパスワード記憶

pwdstorageおよびreverpwdstorageプラグイン関数を登録するパラメータは、次のとおりです。

表17-25 パスワード記憶関数の登録パラメータ

パラメータID	データ型	説明
SLAPI_PLUGIN_PWD_STORAGE_SCHEME_CMP_FN	void *	格納およびエンコードされたパスワードとの比較用にパスワードをエンコードするためにコールされる関数
SLAPI_PLUGIN_PWD_STORAGE_SCHEME_DB_PWD	char *	格納およびエンコードされたユーザー・パスワード
SLAPI_PLUGIN_PWD_STORAGE_SCHEME_DEC_FN	void *	(reverpwdstorageプラグインのみ)暗号化されたパスワードをデコードするためにコールされる関数
SLAPI_PLUGIN_PWD_STORAGE_SCHEME_ENC_FN	void *	記憶域のパスワードをエンコードするためにコールされる関数
SLAPI_PLUGIN_PWD_STORAGE_SCHEME_NAME	char *	サーバーがエンコーディング・スキームを識別するために使用する短いパスワード記憶スキームの名前
SLAPI_PLUGIN_PWD_STORAGE_SCHEME_USER_PWD	char *	クリア・テキストのユーザー・パスワード

17.26 名前変更(RDN変更)

次のパラメータによって、パラメータ・ブロックを介して名前変更するエントリにアクセスできます。

表17-26 名前変更(RDN変更)関数のパラメータ

パラメータID	データ型	説明
SLAPI_MODRDN_DELOLDRDN	int	古い相対識別名(RDN)を削除するかどうか 0: False 1: True
SLAPI_MODRDN_NEWRDN	char *	エントリに割り当てる新しいRDN
SLAPI_MODRDN_NEWSUPERIOR	char *	名前変更されるエントリの新しい親のDN
SLAPI_MODRDN_TARGET	char *	名前変更するエントリのDN
SLAPI_ORIGINAL_TARGET	char *	名前変更するエントリの非正規化されたDN

17.27 結果

次のパラメータによって、パラメータ・ブロックを介して結果にアクセスできます。

表17-27 結果のパラメータ

パラメータID	データ型	説明
SLAPI_ADD_RESCONTROL	LDAPControl *	クライアントに送信するコントロール・セットにコントロールが追加される。 このパラメータでコントロールを追加するには、slapi_pblock_set()を使用する。
SLAPI_RES_CONTROLS	LDAPControl **	クライアントに送信するコントロールの配列。 slapi_pblock_set()と一緒に使用してクライアントに送信するコントロール・セットを変更する場合は、SLAPI_RES_CONTROLSが示す既存のコントロール・セットを取得して解放する必要がある。
SLAPI_RESULT_CODE	int	クライアントに送信する結果コード。
SLAPI_RESULT_MATCHED	char *	LDAP_NO_SUCH_OBJECTをクライアントに送信するときに一致していたターゲットDNの部分。
SLAPI_RESULT_TEXT	char *	クライアントに送信するメッセージ。

17.28 検索

次のパラメータによって、パラメータ・ブロックを介して検索パラメータにアクセスできます。

表17-28 検索関数のパラメータ

パラメータID	データ型	説明
SLAPI_NENTRIES	int	検索によって戻されるエントリの数。
SLAPI_SEARCH_ATTRS	char **	検索結果で戻すための属性タイプの配列。 アスタリスク(*)を使用して、すべての実在(非仮想)属性を示すことができる。
SLAPI_SEARCH_ATTRSONLY	int	属性タイプと属性値の両方を戻すかどうか。 0: 両方を戻す。 1: タイプのみを戻す。
SLAPI_SEARCH_DEREF	int	別名を処理する方法。 LDAP_DEREF_ALWAYS LDAP_DEREF_FINDING LDAP_DEREF_NEVER LDAP_DEREF_SEARCHING
SLAPI_SEARCH_FILTER	Slapi_Filter *	検索に使用されるフィルタ。
SLAPI_SEARCH_REFERRALS	struct berval **	クライアントが参照するその他のLDAPサーバーに対するURLの配列。
SLAPI_SEARCH_RESULT_ENTRY	void *	結果セットによる反復中に戻されるエントリ。 これをSlapi_Entryにキャストすることがある。
SLAPI_SEARCH_SCOPE	int	検索範囲。 LDAP_SCOPE_BASE LDAP_SCOPE_ONELEVEL LDAP_SCOPE_SUBTREE
SLAPI_SEARCH_SIZELIMIT	int	検索結果で戻すエントリの最大数。
SLAPI_SEARCH_STRFILTER	char *	検索に使用されるフィルタの文字列表現。
SLAPI_SEARCH_TARGET	char *	検索のベース・エントリのDN。
SLAPI_SEARCH_TIMELIMIT	int	検索に許可される最大秒数。