PrincipalCollection.Remove Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Удаляет указанного участника из коллекции и возвращает значение true
, если указанный объект-участник являлся элементом коллекции, или значение false
в противном случае (в этом случае операция не выполняется).
Перегрузки
Remove(ComputerPrincipal) |
Удаляет указанный объект ComputerPrincipal из коллекции и возвращает значение |
Remove(GroupPrincipal) |
Удаляет указанный объект GroupPrincipal из коллекции и возвращает значение |
Remove(Principal) |
Удаляет указанный объект Principal из коллекции и возвращает значение |
Remove(UserPrincipal) |
Удаляет указанный объект UserPrincipal из коллекции и возвращает значение |
Remove(PrincipalContext, IdentityType, String) |
Ищет объект UserPrincipal, заданный указанным контекстом PrincipalContext и парой значений |
Комментарии
Как и в случае с Add, существует Contains четыре перегрузки для этой функции, но все они делают то же самое. Дополнительные перегрузки реализуются только для повышения удобства использования, чтобы разработчики, использующие IntelliSense, видели перегрузки, которые принимают UserPrincipalобъект , GroupPrincipalили ComputerPrincipal . Вызов любой из перегрузок "Пользователь", "Группа" или "Компьютер" в точности эквивалентен вызову перегрузки Principal .
Remove(ComputerPrincipal)
- Исходный код:
- PrincipalCollection.cs
- Исходный код:
- PrincipalCollection.cs
- Исходный код:
- PrincipalCollection.cs
Удаляет указанный объект ComputerPrincipal из коллекции и возвращает значение true
, если указанный объект-участник ComputerPrincipal являлся элементом коллекции PrincipalCollection, или значение false
в противном случае (в этом случае операция не выполняется).
public:
bool Remove(System::DirectoryServices::AccountManagement::ComputerPrincipal ^ computer);
public bool Remove (System.DirectoryServices.AccountManagement.ComputerPrincipal computer);
[System.Security.SecurityCritical]
public bool Remove (System.DirectoryServices.AccountManagement.ComputerPrincipal computer);
member this.Remove : System.DirectoryServices.AccountManagement.ComputerPrincipal -> bool
[<System.Security.SecurityCritical>]
member this.Remove : System.DirectoryServices.AccountManagement.ComputerPrincipal -> bool
Public Function Remove (computer As ComputerPrincipal) As Boolean
Параметры
- computer
- ComputerPrincipal
Объект ComputerPrincipal.
Возвращаемое значение
Значение true
, если объект ComputerPrincipal был членом этой PrincipalCollection, в противном случае — значение false
.
- Атрибуты
Комментарии
Эта функция может вызывать следующие исключения:
Исключение | Описание |
---|---|
InvalidOperationException | Этот метод был вызван в Members коллекции для группы доменов, и удаляемый субъект домена является членом группы в силу ее primaryGroupId атрибута. |
Применяется к
Remove(GroupPrincipal)
- Исходный код:
- PrincipalCollection.cs
- Исходный код:
- PrincipalCollection.cs
- Исходный код:
- PrincipalCollection.cs
Удаляет указанный объект GroupPrincipal из коллекции и возвращает значение true
, если указанный объект-участник GroupPrincipal являлся элементом коллекции PrincipalCollection, или значение false
в противном случае (в этом случае операция не выполняется).
public:
bool Remove(System::DirectoryServices::AccountManagement::GroupPrincipal ^ group);
public bool Remove (System.DirectoryServices.AccountManagement.GroupPrincipal group);
[System.Security.SecurityCritical]
public bool Remove (System.DirectoryServices.AccountManagement.GroupPrincipal group);
member this.Remove : System.DirectoryServices.AccountManagement.GroupPrincipal -> bool
[<System.Security.SecurityCritical>]
member this.Remove : System.DirectoryServices.AccountManagement.GroupPrincipal -> bool
Public Function Remove (group As GroupPrincipal) As Boolean
Параметры
- group
- GroupPrincipal
Объект GroupPrincipal.
Возвращаемое значение
Значение true
, если объект GroupPrincipal был членом этой PrincipalCollection, в противном случае — значение false
.
- Атрибуты
Комментарии
Эта функция может вызывать следующие исключения:
Исключение | Описание |
---|---|
InvalidOperationException | Этот метод был вызван в Members коллекции для группы доменов, и удаляемый субъект домена является членом группы в силу ее primaryGroupId атрибута. |
Применяется к
Remove(Principal)
- Исходный код:
- PrincipalCollection.cs
- Исходный код:
- PrincipalCollection.cs
- Исходный код:
- PrincipalCollection.cs
Удаляет указанный объект Principal из коллекции и возвращает значение true
, если указанный объект-участник Principal являлся элементом коллекции PrincipalCollection, или значение false
в противном случае (в этом случае операция не выполняется).
public:
virtual bool Remove(System::DirectoryServices::AccountManagement::Principal ^ principal);
public bool Remove (System.DirectoryServices.AccountManagement.Principal principal);
[System.Security.SecurityCritical]
public bool Remove (System.DirectoryServices.AccountManagement.Principal principal);
abstract member Remove : System.DirectoryServices.AccountManagement.Principal -> bool
override this.Remove : System.DirectoryServices.AccountManagement.Principal -> bool
[<System.Security.SecurityCritical>]
abstract member Remove : System.DirectoryServices.AccountManagement.Principal -> bool
override this.Remove : System.DirectoryServices.AccountManagement.Principal -> bool
Public Function Remove (principal As Principal) As Boolean
Параметры
Возвращаемое значение
Значение true
, если объект Principal был членом этой PrincipalCollection, в противном случае — значение false
.
Реализации
- Атрибуты
Комментарии
Эта функция может вызывать следующие исключения:
Исключение | Описание |
---|---|
InvalidOperationException | Этот метод был вызван в Members коллекции для группы доменов, и удаляемый субъект домена является членом группы в силу ее primaryGroupId атрибута. |
Применяется к
Remove(UserPrincipal)
- Исходный код:
- PrincipalCollection.cs
- Исходный код:
- PrincipalCollection.cs
- Исходный код:
- PrincipalCollection.cs
Удаляет указанный объект UserPrincipal из коллекции и возвращает значение true
, если указанный объект-участник UserPrincipal являлся элементом коллекции PrincipalCollection, или значение false
в противном случае (в этом случае операция не выполняется).
public:
bool Remove(System::DirectoryServices::AccountManagement::UserPrincipal ^ user);
public bool Remove (System.DirectoryServices.AccountManagement.UserPrincipal user);
[System.Security.SecurityCritical]
public bool Remove (System.DirectoryServices.AccountManagement.UserPrincipal user);
member this.Remove : System.DirectoryServices.AccountManagement.UserPrincipal -> bool
[<System.Security.SecurityCritical>]
member this.Remove : System.DirectoryServices.AccountManagement.UserPrincipal -> bool
Public Function Remove (user As UserPrincipal) As Boolean
Параметры
- user
- UserPrincipal
Объект UserPrincipal.
Возвращаемое значение
Значение true
, если объект UserPrincipal был членом этой PrincipalCollection, в противном случае — значение false
.
- Атрибуты
Комментарии
Эта функция может вызывать следующие исключения:
Исключение | Описание |
---|---|
InvalidOperationException | Этот метод был вызван в Members коллекции для группы доменов, и удаляемый субъект домена является членом группы в силу ее primaryGroupId атрибута. |
Применяется к
Remove(PrincipalContext, IdentityType, String)
- Исходный код:
- PrincipalCollection.cs
- Исходный код:
- PrincipalCollection.cs
- Исходный код:
- PrincipalCollection.cs
Ищет объект UserPrincipal, заданный указанным контекстом PrincipalContext и парой значений identityType
/identityValue
из коллекции, и возвращает значение true
, если указанный объект-участник Principal являлся элементом коллекции PrincipalCollection, или значение false
в противном случае (в этом случае операция не выполняется).
public:
bool Remove(System::DirectoryServices::AccountManagement::PrincipalContext ^ context, System::DirectoryServices::AccountManagement::IdentityType identityType, System::String ^ identityValue);
public bool Remove (System.DirectoryServices.AccountManagement.PrincipalContext context, System.DirectoryServices.AccountManagement.IdentityType identityType, string identityValue);
[System.Security.SecurityCritical]
public bool Remove (System.DirectoryServices.AccountManagement.PrincipalContext context, System.DirectoryServices.AccountManagement.IdentityType identityType, string identityValue);
member this.Remove : System.DirectoryServices.AccountManagement.PrincipalContext * System.DirectoryServices.AccountManagement.IdentityType * string -> bool
[<System.Security.SecurityCritical>]
member this.Remove : System.DirectoryServices.AccountManagement.PrincipalContext * System.DirectoryServices.AccountManagement.IdentityType * string -> bool
Public Function Remove (context As PrincipalContext, identityType As IdentityType, identityValue As String) As Boolean
Параметры
- context
- PrincipalContext
Объект PrincipalContext.
- identityType
- IdentityType
Значение IdentityType, определяющее формат identityValue
.
- identityValue
- String
Строка.
Возвращаемое значение
Значение true
, если идентифицированный объект Principal был членом этой PrincipalCollection, в противном случае — значение false
.
- Атрибуты
Комментарии
Эта функция может вызывать следующие исключения:
Исключение | Описание |
---|---|
InvalidOperationException | Этот метод был вызван в Members коллекции для группы доменов, и удаляемый субъект домена является членом группы в силу ее primaryGroupId атрибута. |
NoMatchingPrincipalException | Субъект, соответствующий указанным параметрам, не найден. |
MultipleMatchesException | Несколько субъектов соответствуют указанным параметрам. Теоретически этого не должно происходить, так как Add вызывает исключение при попытке добавить повторяющиеся субъекты в коллекцию. Однако вполне возможно, что дубликат был создан другим API. |
ArgumentException | Параметр identityType равен пустой строке. |