InfoDirectory使用手引書

5.2.20.2 ldap_create_paging_control

　この関数は、ページングを行うためのLDAPControl構造体の作成および初期設定を行います。

【指定形式】

　int　ldap_create_paging_control(
　　　　　　　　　LDAP　　　　　 *ld,
　　　　　　　　　int　　　　　　 pagesize,
　　　　　　　　　const char ctl_iscritical,
　　　　　　　　　LDAPControl　***ctrlp
　　　　　);

【パラメタの説明】

• ld

  　ldap_init()またはldapssl_init()で通知された、セションハンドルを指定します。

• pagesize

  　ページングのサイズを指定します。0以上の数字を指定してください。単位はエントリ数です。

• ctl_iscritical

  　InfoDirectoryサーバがページング機能をサポートしないで、かつ、このパラメタに1が設定されている場合、LDAP_UNAVAILABLE_CRITICAL_EXTENSION(0x0c)エラーを返します。0に設定されている場合、この要求は無視されます。

• ctrlp

  　この関数内で確保されるLDAPControl構造体のアドレスを確保するためのポインタを指定します。このポインタで指す領域は、NULLで初期化されている必要があります。サーバソートとページングを同時に指定するために、すでにldap_create_sort_control()が呼ばれている場合は、そのアドレスをそのまま渡してください。

【復帰値】

　この関数は、復帰値として以下に示す値を返します。

• 正常完了 ： LDAP_SUCCESS
• 異常完了 ： LDAP_SUCCESS以外のLDAPエラーコード

　エラー復帰時には、すでにldap_create_paging_control()が呼ばれている場合、その関数で取得されたLDAPControl構造体にある情報は解放されません。不要な場合、ldap_controls_free()で解放してください。

【注意事項】

• 動的メモリの解放

  　ldap_create_paging_control()で通知された領域は、不要になった時点でldap_controls_free()を使用して解放しなければなりません。

  　詳細は、動的メモリの解放を参照してください。

• LDAPエラーコード

  　LDAPエラーコードの値については、LDAPエラーコードを参照してください。