GPDomain.SearchStarterGpos Method (String)

Article
10/10/2016

Queries for Starter Group Policy object (GPO) that have the specified display name.

Namespace: Microsoft.GroupPolicy
Assembly: Microsoft.GroupPolicy.Management (in Microsoft.GroupPolicy.Management.dll)

Syntax

public StarterGpoCollection SearchStarterGpos(
    string starterGpoDisplayName
)

public:
StarterGpoCollection^ SearchStarterGpos(
    String^ starterGpoDisplayName
)

member SearchStarterGpos : 
        starterGpoDisplayName:string -> StarterGpoCollection

Public Function SearchStarterGpos (
    starterGpoDisplayName As String
) As StarterGpoCollection

Parameters

starterGpoDisplayName
Type: System.String

The display name for which to search.

Return Value

Type: Microsoft.GroupPolicy.StarterGpoCollection

Returns StarterGpoCollection. All the Starter GPOs that have the specified display name in the domain.

Exceptions

Exception	Condition
ArgumentException	starterGpoDisplayName is an empty string (“”).
ArgumentNullException	starterGpoDisplayName is null.

Remarks

Unlike the overloaded GetStarterGpo methods, which throw an exception if more than one Starter GPO with the same display name is found in the domain, this method returns multiple Starter GPOs if more than one Starter GPO with the specified display name exists in the domain.

Share via