4D Doc Center : Set user properties

4D v14.3

Set user properties


Set user properties ( userID ; name ; startup ; password ; nbLogin ; lastLogin {; memberships {; groupOwner}} ) -> 戻り値

引数	型	説明
userID	倍長整数	ユーザアカウントのユニークなID番号、または -1= Designerに関連したユーザの追加 -2= Administratorに関連したユーザの追加
name	文字	新規ユーザの名前
startup	文字	新規ユーザスタートアップメソッドの名前
password	文字	新しい (暗号化されていない) パスワード、または * を指定すると、パスワードは以前のまま
nbLogin	倍長整数	データベースへログインした回数
lastLogin	日付	データベースに最後にログインした日付
memberships	倍長整数配列	ユーザが属すグループのID番号
groupOwner	倍長整数	ユーザーグループオーナーの参照番号
戻り値	倍長整数	新規ユーザのユニークなID番号

説明

Set user properties コマンドを使用すれば、引数 userID に渡したユニークなユーザID番号を持つ既存のユーザアカウントのプロパティを変更および更新することが可能です。また、DesignerあるいはAdministratorに関連する新規ユーザを追加することもできます。

既存のユーザアカウントのプロパティを変更している場合は、GET USER LIST コマンドによって返された有効なユーザID番号を渡さなければなりません。

ユーザアカウントが存在しない場合や削除された場合、エラーコード -9979が返されます。ON ERR CALL コマンドを用いてインストールされたエラー処理メソッドでこのエラーを検知することができます。その他では、関数 Is user deleted を呼び出してユーザアカウントをテストし、その後 Set user properties コマンドを呼び出す方法があります。

ユーザID番号は以下の値および範囲を持っています。

ユーザID番号	ユーザ説明
1	Designerユーザ
2	Administratorユーザ
3 ~ 15000	データベースのDesignerによって作成されたユーザ (ユーザ番号3はDesignerによって最初に作成されたユーザ、ユーザ番号4は、2番目に作成されたユーザなど)
-11 ~ -15000	データベースのAdministratorによって作成されたユーザ (ユーザ番号-11はAdministratorによって最初に作成されたユーザ、ユーザ番号-12は、2番目に作成されたユーザなど)

Designerに関連する新規ユーザを追加するには、引数 userID に -1を渡します。Administratorに関連する新規ユーザを追加するには、引数 userID に -2を渡します。呼び出し後、ユーザの追加および修正が完了すると、そのユニークなID番号が引数 userID に返されます。

-1、 -2 または有効なユーザID番号が渡されない場合、Set user properties コマンドは何も行いません。

呼び出す前に、引数 name、startup、password、nbLogin と lastLogin にユーザの新しい名前、スタートアップメソッド、パスワード、ログインした回数と最後にログインした日付を渡します。引数 password に暗号化されていないパスワードを渡すと、4Dはそのパスワードを暗号化し、ユーザアカウントに格納します。
引数 name に渡された新規ユーザの名前がユニークでない場合 (同じ名前を持つユーザが既に存在している) 、コマンドは何も行わず、エラーコード-9979が返されます。ON ERR CALL コマンドを用いてインストールされたエラー処理メソッドでこのエラーを検知することができます。

ユーザのすべてのプロパティを変更したくない場合 (メンバーシップ以外、以下参照) 、最初にGET USER PROPERTIES コマンドを呼び出し、変更したくないプロパティに対して返された値を渡します。

アカウント用のパスワードを変更したくない場合、引数 password の値として、* 記号を渡します。これを実行することにより、アカウント用のパスワードを変更することなく、ユーザアカウントの他のプロパティを変更することができます。

オプション引数 memberships が渡されないと、現在のユーザのメンバーシップは変更されません。
ユーザを追加している際に、引数 memberships が渡されないと、そのユーザはどのグループにも属しません。オプション引数 memberships を渡すと、そのユーザの全てのメンバーシップを変更します。呼び出す前に、そのユーザが属するグループのユニークなID番号を配列 memberships に割り当てなければなりません。

オプション引数 groupOwner を渡すと、ユーザグループ "オーナー" のID番号、つまり、このユーザによって作成されたオブジェクトのデフォルトのオーナーグループを指定します。

グループID番号は以下の値および範囲を持っています。

グループID番号	グループ説明
15001 ~ 32767	Designerまたは関連するグループオーナーによって作成されたグルーブ (グループ番号15001は、Designerによって最初に作成されたグループ、グループ番号15002は、2番目に作成されたグループなど)
-15001 ~ -32768	Administratorまたは関連するグループオーナーによって作成されたグループ (グループ番号-15001は、Administratorによって最初に作成されたグループ、グループ番号-15002は、2番目に作成されたグループなど)

ユーザのすべてのメンバーシップを無効にするには、空の配列 memberships を渡します。

エラー管理

コマンドを呼び出すための特定のアクセス権を持っていない場合や、パスワードシステムが他のプロセスによって既にアクセスされている場合は、アクセス権エラーが生成されます。ON ERR CALLコマンドを使ってインストールされたエラー処理メソッドでこのエラーを受け取ることができます。