PrincipalCollection.Remove 方法
定義
重要
部分資訊涉及發行前產品,在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。
從集合中移除指定的主體,如果指定的主體物件原本是集合成員,則傳回 true
,否則傳回 false
(在此情況下,不會執行任何作業)。
多載
Remove(ComputerPrincipal) |
從集合中移除指定的 ComputerPrincipal 物件,如果 ComputerPrincipal 以前是這個 PrincipalCollection 的成員,則傳回 |
Remove(GroupPrincipal) |
從集合中移除指定的 GroupPrincipal 物件,如果 GroupPrincipal 以前是這個 PrincipalCollection 的成員,則傳回 |
Remove(Principal) |
從集合中移除指定的 Principal 物件,如果 Principal 以前是這個 PrincipalCollection 的成員,則傳回 |
Remove(UserPrincipal) |
從集合中移除指定的 UserPrincipal 物件,如果 UserPrincipal 以前是這個 PrincipalCollection 的成員,則傳回 |
Remove(PrincipalContext, IdentityType, String) |
從集合中尋找由特定 PrincipalContext 和 |
備註
和 一 Add樣,此 Contains 函式有四個多載,但它們全都會執行相同的動作。 額外的多載只會實作以改善可用性,讓使用 IntelliSense 的開發人員會看到採用 UserPrincipal、 GroupPrincipal或 ComputerPrincipal 物件的多載。 呼叫任何一個使用者、群組或計算機多載,與呼叫多 Principal 載完全相同。
Remove(ComputerPrincipal)
從集合中移除指定的 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
參數
- computer
- ComputerPrincipal
傳回
若 ComputerPrincipal 為此 PrincipalCollection 的成員,則為 true
;否則為 false
。
- 屬性
備註
此函式可能會擲回下列例外狀況:
例外狀況 | 描述 |
---|---|
InvalidOperationException | 這個方法是在網域群組的 Members 集合上呼叫,而且要移除的網域主體是群組的成員,其屬性是 primaryGroupId 群組的成員。 |
適用於
Remove(GroupPrincipal)
從集合中移除指定的 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)
從集合中移除指定的 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 為此 PrincipalCollection 的成員,則為 true
;否則為 false
。
實作
- 屬性
備註
此函式可能會擲回下列例外狀況:
例外狀況 | 描述 |
---|---|
InvalidOperationException | 這個方法是在網域群組的 Members 集合上呼叫,而且要移除的網域主體是群組的成員,其屬性是 primaryGroupId 群組的成員。 |
適用於
Remove(UserPrincipal)
從集合中移除指定的 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)
從集合中尋找由特定 PrincipalContext 和 identityType
/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
參數
- context
- PrincipalContext
PrincipalContext 物件。
- identityType
- IdentityType
IdentityType,會識別 identityValue
的格式。
- identityValue
- String
字串。
傳回
若識別的 Principal 為此 PrincipalCollection 的成員,則為 true
;否則為 false
。
- 屬性
備註
此函式可能會擲回下列例外狀況:
例外狀況 | 描述 |
---|---|
InvalidOperationException | 這個方法是在網域群組的 Members 集合上呼叫,而且要移除的網域主體是群組的成員,其屬性是 primaryGroupId 群組的成員。 |
NoMatchingPrincipalException | 找不到符合指定參數的主體。 |
MultipleMatchesException | 多個主體符合指定的參數。 理論上,這應該永遠不會發生,因為 Add 嘗試將重複的主體新增至集合時,會擲回例外狀況。 不過,另一個 API 可能會建立重複專案。 |
ArgumentException | identityType 為空字串。 |