SPGroupCollection.Add - Méthode

Ajoute un groupe à la collection de groupes dans une collection de sites.

Espace de noms :  Microsoft.SharePoint
Assembly :  Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
Public Sub Add ( _
    name As String, _
    owner As SPMember, _
    defaultUser As SPUser, _
    description As String _
)
'Utilisation
Dim instance As SPGroupCollection
Dim name As String
Dim owner As SPMember
Dim defaultUser As SPUser
Dim description As String

instance.Add(name, owner, defaultUser, _
    description)
public void Add(
    string name,
    SPMember owner,
    SPUser defaultUser,
    string description
)

Paramètres

  • name
    Type : System.String

    Une chaîne qui représente le nom du nouveau groupe.

  • description
    Type : System.String

    Chaîne qui contient une description du groupe.

Exceptions

Exception Condition
ArgumentException

owner est null .

SPException

La collection de groupe est en lecture seule.

- ou -

Le propriétaire est un rôle ou groupe de domaine.

- ou -

Le groupe n'est pas un groupe au niveau du site.

Exemples

L'exemple de code suivant crée un groupe dans la collection de sites actuelle.

Dim webSite As SPWeb = SPContext.Current.Site.RootWeb
Try
    Dim groups As SPGroupCollection = webSite.SiteGroups
    Dim user As SPUser = webSite.Users("User_Name")
    Dim member As SPMember = webSite.Users("User_Name")

    groups.Add("Group_Name", member, user, "Description")
Finally
    webSite.Dispose()
End Try
using (SPWeb oWebsiteRoot = SPContext.Current.Site.RootWeb)
{
    SPGroupCollection collGroups = oWebsiteRoot.SiteGroups;
    SPUser oUser = oWebsiteRoot.Users["User_Name"];
    SPMember oMember = oWebsiteRoot.Users["User_Name"];

    collGroups.Add("Group_Name", oMember, oUser, "Description");
}

Notes

Certains objets implémentent l'interface IDisposable , et vous devez éviter de conserver ces objets dans la mémoire après que qu'ils ne sont plus nécessaires. Pour plus d'informations sur les bonnes pratiques de codage, consultez Disposing Objects.

Voir aussi

Référence

SPGroupCollection classe

SPGroupCollection - Membres

Microsoft.SharePoint - Espace de noms