Interstage Application Server Smart Repository運用ガイド |
目次 索引 |
第5章 アプリケーションの作成(C API) | > 5.2 C API仕様 |
関数名 |
関数の説明 |
---|---|
指定されたエントリを更新します。 |
|
指定されたエントリを更新します。 |
|
指定されたエントリを更新します。 |
|
指定されたエントリを更新します。 |
この関数は、非同期型のエントリ変更処理を行います。
非同期型検索の処理結果を受け取る場合、ldap_result()を使用します。この時、ldap_modify()の復帰値として返されたメッセージIDを指定します。詳細は、“処理結果の受取り/判定”を参照してください。
ldapssl_init()で獲得したセションハンドルを使用している場合、SSLライブラリで発生したエラーをldapssl_error()で参照することができます。
【指定形式】
#include "idldap.h" int ldap_modify( LDAP *ld, char *dn, LDAPMod **mods ); |
【パラメタの説明】
ldap_init()、またはldapssl_init()で通知された、セションハンドルを指定します。
変更するエントリのアドレスを指定します。
LDAPMod構造体のポインタ配列のアドレスを指定します。ここで指定するポインタ配列は、最後の項目にNULLを設定しておく必要があります。各LDAPMod構造体には、属性ごとの変更情報を設定します。LDAPMod構造体の各項目に設定する値は、以下のとおりです。
属性値の種類と、変更操作の種類の論理和をとったものを指定します。
変更する属性の名前のアドレスを指定します。一部の属性では属性名に“;binary”を付加したものを指定する必要があります。
追加/削除/置換する属性値のアドレスを指定します。ここで指定する属性値は、mod_vals共用体のポインタ配列です。このポインタ配列は、最後の項目にNULLを設定する必要があります。
mod_vals共用体のメンバは、mod_opパラメタに指定された属性値の種類によって、以下のどちらかを使用します。
各属性値のポインタ配列は、最後の項目にNULLを設定しておく必要があります。
modifyにおいて、以下の変更(文字列データの変更)を行う場合のパラメタの例を下図に示します。
|
modifyにおいて、以下の変更(バイナリデータの変更)を行う場合のパラメタの例を下図に示します。
jpegPhoto --------------------> 追加 |
【復帰値】
この関数は、復帰値として以下の値を返します。
異常完了の場合、以下の原因が考えられます。
この関数は、同期型のエントリ変更処理を行います。
ldapssl_init()で獲得したセションハンドルを使用している場合、SSLライブラリで発生したエラーをldapssl_error()で参照することができます。
【指定形式】
#include "idldap.h" int ldap_modify_s( LDAP *ld, char *dn, LDAPMod **mods ); |
【パラメタの説明】
ldap_init()、またはldapssl_init()で通知された、セションハンドルを指定します。
変更するエントリのDNを指定します。
LDAPMod構造体のポインタ配列のアドレスを指定します。ここで指定するポインタ配列は、最後の項目にNULLを設定しておく必要があります。各LDAPMod構造体には、属性ごとの変更情報を設定します。LDAPMod構造体の各項目に設定する値は、以下のとおりです。
属性値の種類と、変更操作の種類の論理和をとったものを指定します。
変更する属性の名前のアドレスを指定します。一部の属性では属性名に“;binary”を付加したものを指定する必要があります。
追加/削除/置換する属性値のアドレスを指定します。ここで指定する属性値は、mod_vals共用体のポインタ配列です。このポインタ配列は、最後の項目にNULLを設定しておく必要があります。
mod_vals共用体のメンバは、mod_opパラメタに指定された属性値の種類によって、以下のどちらかを使用します。
各属性値のポインタ配列は、最後の項目にNULLを設定しておく必要があります。
変更を行う場合のパラメタの例については、“modifyにおけるパラメタの例”を参照してください。
【復帰値】
この関数では、復帰値としてLDAPエラーコードを返します。LDAPエラーコードの値については、“LDAPエラーコード”を参照してください。
この関数は、非同期型のエントリ変更処理を行います。
非同期関数の処理結果を受け取る場合、ldap_result()を使用します。この時、ldap_modify_ext()の復帰値として返されたメッセージIDを指定します。詳細は、“処理結果の受取り/判定”を参照してください。
ldapssl_init()で獲得したセションハンドルを使用している場合、SSLライブラリで発生したエラーをldapssl_error()で参照することができます。
【指定形式】
#include "idldap.h" int ldap_modify_ext( LDAP *ld, char *dn, LDAPMod **mods, LDAPControl **serverctrls, LDAPControl **clientctrls, int *msgidp ); |
【パラメタの説明】
ldap_init()、またはldapssl_init()で通知された、セションハンドルを指定します。
変更するDNを指定します。
LDAPMod構造体のポインタ配列のアドレスを指定します。ここで指定するポインタ配列は、最後の項目にNULLを設定しておく必要があります。各LDAPMod構造体には、属性ごとの変更情報を設定します。LDAPMod構造体の各項目に設定する値は、以下のとおりです。
属性値の種類と、変更操作の種類の論理和をとったものを指定します。
変更する属性の名前のアドレスを指定します。一部の属性では属性名に“;binary”を付加したものを指定する必要があります。
追加/削除/置換する属性値のアドレスを指定します。ここで指定する属性値は、mod_vals共用体のポインタ配列です。このポインタ配列は、最後の項目にNULLを設定しておく必要があります。
mod_vals共用体のメンバは、mod_opパラメタに指定された属性値の種類によって、以下のどちらかを使用します。
各属性値のポインタ配列は、最後の項目にNULLを設定しておく必要があります。
変更を行う場合のパラメタの例については、“modifyにおけるパラメタの例”を参照してください。
Smart Repositoryではサーバコントロールをサポートしていないため、このパラメタにはNULLを指定します。
本ライブラリではクライアントコントロールをサポートしていないため、このパラメタにはNULLを指定します。
メッセージIDを格納するための変数のアドレスを指定します。
【復帰値】
この関数では、復帰値としてLDAPエラーコードを返します。LDAPエラーコードの値については、“LDAPエラーコード”を参照してください。
また、正常完了の場合には、msgidpパラメタで指定した変数にメッセージIDが設定されています。
この関数は、同期型のエントリ変更処理を行います。
ldapssl_init()で獲得したセションハンドルを使用している場合、SSLライブラリで発生したエラーをldapssl_error()で参照することができます。
【指定形式】
#include "idldap.h" int ldap_modify_ext_s( LDAP *ld, char *dn, LDAPMod **mods, LDAPControl **serverctrls, LDAPControl **clientctrls ); |
【パラメタの説明】
ldap_init()、またはldapssl_init()で通知された、セションハンドルを指定します。
変更するDNを指定します。
LDAPMod構造体のポインタ配列のアドレスを指定します。ここで指定するポインタ配列は、最後の項目にNULLを設定しておく必要があります。各LDAPMod構造体には、属性ごとの変更情報を設定します。LDAPMod構造体の各項目に設定する値は、以下のとおりです。
属性値の種類と、変更操作の種類の論理和をとったものを指定します。
変更する属性の名前のアドレスを指定します。一部の属性では属性名に“;binary”を付加したものを指定する必要があります。
追加/削除/置換する属性値のアドレスを指定します。ここで指定する属性値は、mod_vals共用体のポインタ配列です。このポインタ配列は、最後の項目にNULLを設定しておく必要があります。
mod_vals共用体のメンバは、mod_opパラメタに指定された属性値の種類によって、以下のどちらかを使用します。
各属性値のポインタ配列は、最後の項目にNULLを設定しておく必要があります。
変更を行う場合のパラメタの例については、“modifyにおけるパラメタの例”を参照してください。
Smart Repositoryではサーバコントロールをサポートしていないため、このパラメタにはNULLを指定します。
本ライブラリではクライアントコントロールをサポートしていないため、このパラメタにはNULLを指定します。
【復帰値】
この関数では、復帰値としてLDAPエラーコードを返します。LDAPエラーコードの値については、“LDAPエラーコード”を参照してください。
目次 索引 |