GET USER PROPERTIES
GET USER PROPERTIES ( userID ; name ; startup ; password ; nbLogin ; lastLogin {; memberships {; groupOwner}} )
引数 | 型 | 説明 | |
---|---|---|---|
userID | Integer | → | ユニークなユーザーID番号 |
name | Text | ← | ユーザー名 |
startup | Text | ← | スタートアップメソッドの名前 |
password | Text | ← | 常に空の文字列 |
nbLogin | Integer | ← | データベースにログインした回数 (バイナリデータベースのみ) |
lastLogin | Date | ← | データベースに最後にログインした日付 (バイナリデータベースのみ) |
memberships | Integer array | ← | ユーザーが属するグループのID番号 |
groupOwner | Integer | ← | ユーザーのグループオーナーのID番号 (バイナリデータベースのみ) |
このコマンドはスレッドセーフではないため、プリエンプティブなコードには使えません。
説明
GET USER PROPERTIES コマンドは、引数 userID に渡したユニークなユーザーID番号を持つユーザーに関する情報を返します。必ず GET USER LIST コマンドによって返される有効なユーザーID番号を渡さなければなりません。
ユーザーアカウントが存在しない場合や削除されている場合、エラーコード -9979が返されます。ON ERR CALL コマンドを用いて実装されたエラー処理メソッドでこのエラーを検知することができます。また、あらかじめ Is user deleted でユーザーアカウントを検証してから、GET USER PROPERTIES コマンドを呼び出す方法もあります。
呼び出し後、引数 name、startup、 nbLogin と lastLogin には、ユーザー名、スタートアップメソッド、ログインした回数と最後にログインした日付が返されます。
注:
- nbLogin および lastLogin パラメーターはバイナリデータベースでのみ使用され、プロジェクトデータベースにおいては常に 0 および 00/00/00 が返されます。
- password 引数は廃止予定となりました (常に空の文字列を返します)。ユーザーのパスワードをチェックしたい場合、Validate password を使用して下さい。
任意の引数 memberships を渡すと、ユーザーが属するグループのユニークなID番号が返されます。
(バイナリデータベースのみ) 任意の引数 groupOwner を渡すと、ユーザーグループ "オーナー" のID番号、つまり、このユーザーによって作成されたオブジェクトのデフォルトのオーナーグル ープを取得します。
注: プロジェクトデータベースにおいては、groupOwner 配列には 0 の値が返されます。
バイナリデータベースに関する注記: グループおよびユーザーIDの値は、その作成者に依存します (デザイナー、管理者、または関連したグループオーナー)。詳細については ユーザーとグループ ID の範囲 を参照ください。
エラー管理
コマンドを呼び出すための特定のアクセス権を持っていない場合や、パスワードシステムが他のプロセスによって既にアクセスされている場合は、アクセス権エラーが生成されます。ON ERR CALL コマンドを使ってインストールされたエラー処理メソッドでこのエラーを受け取ることができます。
参照
GET GROUP LIST
GET USER LIST
Is user deleted
Set user properties
Validate password