version 6.0
Set group properties (groupID; name; owner{; members}) 数値
| 引数 | 型 | 説明 | |
| groupID | 数値 | グループのユニークなID番号、または、 | |
| -1= 設計者グループの追加 | |||
| -2= 管理者グループの追加 | |||
| name | 文字列 | 新規グループの名前 | |
| owner | 数値 | 新規グループオーナーのユーザID番号 | |
| members | 数値配列 | 新規グループのメンバー | |
| 戻り値 | 数値 | 新規グループのユニークなID番号 |
説明
Set group properties コマンドを使用すれば、引数 groupID に渡したユニークなグループID番号を持つ既存のグループのプロパティを変更および更新することが可能です。また、設計者あるいは管理者に関連する新規グループを追加することもできます。
既存グループのプロパティを変更している場合は、GET GROUP LIST コマンドによって返された有効なグループID番号を渡さなければなりません。グループID番号は以下の値および範囲を持っています。
| グループID番号 | グループ説明 |
| 15001 to 32767 | 設計者または関連するグループオーナーによって作成されたグルーブ |
| (グループ番号15001は、設計者によって最初に作成されたグループ、グル ープ番号15002は、2番目に作成されたグループなど) | |
| -15001 to -32768 | 管理者または関連するグループオーナーによって作成されたグループ |
| (グループ番号-15001は、管理者によって最初に作成されたグループ、グ ループ番号-15002は、2番目に作成されたグループなど) |
設計者に関連する新規グループを追加するには、引数 groupID に -1を渡します。管理者に関連する新規グループを追加するには、引数 groupID に -2を渡します。呼び出し後、グループの追加が完了すると、そのユニークなID番号が引数 groupID に返されます。
-1、 -2 または有効なグループID番号が渡されない場合、Set group properties コマンドは何も行いません。
呼び出す前に、引数 name と owner にグループの新しい名前とオーナーを渡します。グループのすべてのプロパティを変更したくない場合 (メンバー以外、以下参照) 、最初にGET GROUP PROPERTIES コマンドを呼び出し、変更したくないプロパティに対して返された値を渡します。
オプション引数 members が渡されないと、現在のグループのメンバーリストは変更されません。
グループを追加している際に、引数 members が渡されないと、そのグループにはメンバーが追加されません。
Note: グループオーナーは自身が所有するグループのメンバーとして自動的に設定されるわけではありません。引数 members を使用して、グループオーナーをそのグループに含めるかどうかはユーザ次第です。
オプション引数 members を渡すと、そのグループのメンバーリスト全体を変更します。呼び出す前に、そのグループがメンバーとして取得するユーザとグループのユニークなID番号を配列 members に割り当てなければなりません。
| メンバーID番号 | メンバー説明 |
| 1 | 設計者ユーザ |
| 2 | 管理者ユーザ |
| 3 to 15000 | データベースの設計者によって作成されたユーザ |
| (ユーザ番号3は、 設計者によって最初に作成されたユーザ、ユーザ番号 |
4は、2番目に作成されたユーザなど)
| -11 to -15000 | データベースの管理者によって作成されたユーザ |
| (ユーザ番号-11は、管理者によって最初に作成されたユーザ、ユーザ番号- |
12は、2番目に作成されたユーザなど)
| 15001 to 32767 | 設計者または関連するグループオーナーによって作成されたグルーブ |
| (グループ番号15001は、設計者によって最初に作成されたグループ、グル ープ番号15002は、2番目に作成されたグループなど) | |
| -15001 to -32768 | 管理者または関連するグループオーナーによって作成されたグループ |
| (グループ番号-15001は、管理者によって最初に作成されたグループ、グ ループ番号-15002は、2番目に作成されたグループなど) |
グループからすべてのメンバーを削除するには、空の配列 members を渡します。
参照
GET GROUP LIST, GET GROUP PROPERTIES, GET USER LIST.
エラー処理
Set group properties コマンドを呼び出すための特定のアクセス権を持っていない場合や、パスワードシステムが他のプロセスによって既にアクセスされている場合は、アクセス権エラーが生成されます。ON ERR CALL コマンドを使ってインストールされたエラー処理メソッドでこのエラーを受け取ることができます。