REST.Backend.EMSServices.TEMSGroupsAPI.RemoveUsers
Delphi
function RemoveUsers(const AGroupName: string; const AUsers: TArray<string>; out AUpdatedObject: TBackendEntityValue): Boolean;
C++
bool __fastcall RemoveUsers(const System::UnicodeString AGroupName, const System::DynamicArray<System::UnicodeString> AUsers, /* out */ Rest::Backend::Metatypes::TBackendEntityValue &AUpdatedObject);
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
| function | protected | REST.Backend.EMSServices.pas REST.Backend.EMSServices.hpp |
REST.Backend.EMSServices | TEMSGroupsAPI |
説明
指定のユーザーを指定のグループから削除するように要求します。要求した変更が EMS サーバーで適用された場合は True を返し、EMS サーバーからエラーが返された場合は False を返します。
RemoveUsers が受け取るパラメータは次のとおりです。
AGroupName： 対象となるグループの名前です。AUsers： 対象となるグループから削除するユーザー ID 文字列の配列です。AUpdatedObject： 要求した変更が EMS サーバーで適用された場合に RemoveUsers でその日付と時刻を格納する TBackendEntityValue インスタンスです。
例外
| 例外 | メッセージ | 説明 |
|---|---|---|
|
グループ名が必要です |
指定されたグループ名が空の文字列になっています。 | |
|
MasterSecret が必要です |
認証の種類が TAuthentication.MasterSecret で、基になる EMS バックエンド サービスの接続情報の MasterSecret プロパティが空の文字列になっています。 | |
|
セッション トークンが必要です |
認証の種類が TAuthentication.Session で、かつ、ログインが行われませんでした。 |