PrincipalCollection.Remove 方法

定义

从集合中移除指定的主体,并在指定主体对象是集合成员时返回 true,否则将返回 false(这种情况下不会执行任何操作)。

重载

Remove(ComputerPrincipal)

从集合中移除指定的 ComputerPrincipal 对象,并在 ComputerPrincipal 是此 PrincipalCollection 的成员时返回 true,否则将返回 false(这种情况下方法不会执行任何操作)。

Remove(GroupPrincipal)

从集合中移除指定的 GroupPrincipal 对象,并在 GroupPrincipal 是此 PrincipalCollection 的成员时返回 true,否则将返回 false(这种情况下方法不会执行任何操作)。

Remove(Principal)

从集合中移除指定的 Principal 对象,并在 Principal 是此 PrincipalCollection 的成员时返回 true,否则将返回 false(这种情况下方法不会执行任何操作)。

Remove(UserPrincipal)

从集合中移除指定的 UserPrincipal 对象,并在 UserPrincipal 是此 PrincipalCollection 的成员时返回 true,否则将返回 false(这种情况下方法不会执行任何操作)。

Remove(PrincipalContext, IdentityType, String)

从集合中查找由给定的 PrincipalContextidentityType/identityValue 对指定的 UserPrincipal 对象,并在标识的 Principal 是此 PrincipalCollection 的成员时返回 true,否则将返回 false(这种情况下方法不会执行任何操作)。

注解

与 一 Add样, Contains 此函数有四个重载,但它们都执行相同的操作。 实现额外的重载只是为了提高可用性,以便使用 IntelliSense 的开发人员可以看到采用 UserPrincipalGroupPrincipalComputerPrincipal 对象的重载。 调用任何一个用户、组或计算机重载与调用重 Principal 载完全等效。

Remove(ComputerPrincipal)

Source:
PrincipalCollection.cs
Source:
PrincipalCollection.cs
Source:
PrincipalCollection.cs

从集合中移除指定的 ComputerPrincipal 对象,并在 ComputerPrincipal 是此 PrincipalCollection 的成员时返回 true,否则将返回 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

参数

返回

如果 ComputerPrincipal 是此 PrincipalCollection 的成员,则为 true;否则为 false

属性

注解

此函数可能会引发以下异常:

例外 描述
InvalidOperationException 此方法是在域组的集合上 Members 调用的,并且要删除的域主体是组的一个成员,因为它 primaryGroupId 具有 属性。

适用于

Remove(GroupPrincipal)

Source:
PrincipalCollection.cs
Source:
PrincipalCollection.cs
Source:
PrincipalCollection.cs

从集合中移除指定的 GroupPrincipal 对象,并在 GroupPrincipal 是此 PrincipalCollection 的成员时返回 true,否则将返回 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 对象。

返回

如果 GroupPrincipal 是此 PrincipalCollection 的成员,则为 true;否则为 false

属性

注解

此函数可能会引发以下异常:

例外 描述
InvalidOperationException 此方法是在域组的集合上 Members 调用的,并且要删除的域主体是组的一个成员,因为它 primaryGroupId 具有 属性。

适用于

Remove(Principal)

Source:
PrincipalCollection.cs
Source:
PrincipalCollection.cs
Source:
PrincipalCollection.cs

从集合中移除指定的 Principal 对象,并在 Principal 是此 PrincipalCollection 的成员时返回 true,否则将返回 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

参数

principal
Principal

Principal 对象。

返回

如果 Principal 是此 PrincipalCollection 的成员,则为 true;否则为 false

实现

属性

注解

此函数可能会引发以下异常:

例外 描述
InvalidOperationException 此方法是在域组的集合上 Members 调用的,并且要删除的域主体是组的一个成员,因为它 primaryGroupId 具有 属性。

适用于

Remove(UserPrincipal)

Source:
PrincipalCollection.cs
Source:
PrincipalCollection.cs
Source:
PrincipalCollection.cs

从集合中移除指定的 UserPrincipal 对象,并在 UserPrincipal 是此 PrincipalCollection 的成员时返回 true,否则将返回 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 对象。

返回

如果 UserPrincipal 是此 PrincipalCollection 的成员,则为 true;否则为 false

属性

注解

此函数可能会引发以下异常:

例外 描述
InvalidOperationException 此方法是在域组的集合上 Members 调用的,并且要删除的域主体是组的一个成员,因为它 primaryGroupId 具有 属性。

适用于

Remove(PrincipalContext, IdentityType, String)

Source:
PrincipalCollection.cs
Source:
PrincipalCollection.cs
Source:
PrincipalCollection.cs

从集合中查找由给定的 PrincipalContextidentityType/identityValue 对指定的 UserPrincipal 对象,并在标识的 Principal 是此 PrincipalCollection 的成员时返回 true,否则将返回 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

参数

identityType
IdentityType

一个 IdentityType,标识 identityValue 的格式。

identityValue
String

一个字符串。

返回

如果标识的 Principal 是此 PrincipalCollection 的成员,则为 true;否则为 false

属性

注解

此函数可能会引发以下异常:

例外 描述
InvalidOperationException 此方法是在域组的集合上 Members 调用的,并且要删除的域主体是组的一个成员,因为它 primaryGroupId 具有 属性。
NoMatchingPrincipalException 找不到与指定参数匹配的主体。
MultipleMatchesException 多个主体与指定的参数匹配。 从理论上讲,这不应该发生,因为 Add 当尝试向集合添加重复主体时,会引发异常。 但是,另一个 API 可能创建了重复项。
ArgumentException identityType 是一个空字符串。

适用于