Partager via


New-SPExcelUserDefinedFunction

Ajoute une nouvelle fonction définie par l'utilisateur à l'application Excel Services.

Syntaxe

Default (Par défaut)

New-SPExcelUserDefinedFunction
    -Assembly <String>
    -ExcelServiceApplication <SPExcelServiceApplicationPipeBind>
    [-AssemblyLocation <AssemblyLocation>]
    [-AssignmentCollection <SPAssignmentCollection>]
    [-Confirm]
    [-Description <String>]
    [-Enable]
    [-WhatIf]
    [<CommonParameters>]

Description

L’applet New-SPExcelUserDefinedFunction de commande ajoute une fonction définie par l’utilisateur à une application de service web Excel Services Application. Excel Services Application utilise uniquement les fonctions définies par l’utilisateur qui ont une entrée dans la liste des fonctions définies par l’utilisateur. Les fonctions définies par l’utilisateur sont des assemblys de code managé qui peuvent être appelés à partir d’un classeur Excel Services Application à l’aide de la syntaxe de formule standard Excel Services Application. Les assemblys peuvent effectuer une logique personnalisée ou d’autres actions, comme l’actualisation des données. Les applets de commande Windows PowerShell opèrent sur les entrées de la liste des fonctions définies par l’utilisateur et non sur les assemblys.

Pour les autorisations et les informations les plus récentes sur Windows PowerShell pour les produits SharePoint, consultez la documentation en ligne sur les applets de commande SharePoint Server.

Exemples

EXEMPLE

Get-SPExcelServiceApplication | New-SPExcelUserDefinedFunction -Assembly "SampleCompany.SampleApplication.SampleUdf" -AssemblyLocation GAC

Cet exemple ajoute le fichier SampleComany.SampleApplication.SampleUdf à chaque application de service web Excel Services Application dans la batterie de serveurs.

L’assembly de la fonction définie par l’utilisateur est déployé dans le Global Assembly Cache (GAC).

Paramètres

-Assembly

Applicable : SharePoint Server 2010, SharePoint Server 2013

Spécifie le nom fortement typé de l’assembly. Le nom doit être unique dans la liste des fonctions définies par l’utilisateur. Le nom peut comporter un maximum de 4 096 caractères alphanumériques.

Le type doit être une chaîne de caractères alphanumériques, par exemple :

-- SampleCompany.SampleApplication.SampleUdf -- C:\UDFs\SampleUdf.dll -- \\MyNetworkServer\UDFs\SampleUdf.dll

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-AssemblyLocation

Applicable : SharePoint Server 2010, SharePoint Server 2013

Spécifie l’emplacement de stockage de l’assembly. La valeur par défaut est GAC.

Le type doit être l’un des suivants : GAC ou LocalFile.

Propriétés du paramètre

Type:AssemblyLocation
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-AssignmentCollection

Applicable : SharePoint Server 2010, SharePoint Server 2013

Gère les objets de manière à optimiser leur libération. L'utilisation d'objets, tels que SPWeb ou SPSite, peut consommer des quantités de mémoire élevées et le recours à ces objets dans des scripts Windows PowerShell implique une gestion appropriée de la mémoire. À l'aide de l'objet SPAssignment, vous pouvez affecter des objets à une variable et les libérer dès qu'ils ne sont plus nécessaires afin de libérer de la mémoire. Lorsque les objets SPWeb, SPSite ou SPSiteAdministration sont utilisés, ils sont automatiquement libérés si une collection d’attributions ou le paramètre Global ne sont pas utilisés.

Lorsque le paramètre Global est utilisé, tous les objets sont contenus dans le magasin global. Si des objets ne sont pas utilisés immédiatement ou libérés à l’aide de la commande Stop-SPAssignment, un scénario d’insuffisance de mémoire peut se produire.

Propriétés du paramètre

Type:SPAssignmentCollection
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Confirm

Applicable : SharePoint Server 2010, SharePoint Server 2013

Vous demande une confirmation avant d’exécuter la commande. Pour plus d’informations, entrez la commande suivante : get-help about_commonparameters

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:cf

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Description

Applicable : SharePoint Server 2010, SharePoint Server 2013

Spécifie une description conviviale de la fonction définie par l’utilisateur. Le nom peut contenir 4096 caractères alphanumériques maximum. La valeur par défaut est une chaîne vide.

Le type doit être une chaîne valide de caractères alphanumériques, par exemple « Ceci est la fonction définie par l’utilisateur pour les rapports de consolidation ».

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Enable

Applicable : SharePoint Server 2010, SharePoint Server 2013

Active la fonction définie par l’utilisateur pour une utilisation avec Excel Services Application. La valeur par défaut est True.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ExcelServiceApplication

Applicable : SharePoint Server 2010, SharePoint Server 2013

Spécifie l’application de service web Excel Services Application qui contient la liste des fonctions définies par l’utilisateur.

Le type doit être un GUID valide, au format 12345678-90ab-cdef-1234-567890bcdefgh ; nom valide d’une application de service Web Excel Services Application dans la batterie (par exemple, MyExcelService1) ou instance d’un objet SPExcelServiceApplication valide.

Propriétés du paramètre

Type:SPExcelServiceApplicationPipeBind
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-WhatIf

Applicable : SharePoint Server 2010, SharePoint Server 2013

Affiche un message qui explique l’effet de la commande au lieu de l’exécuter. Pour plus d’informations, entrez la commande suivante : get-help about_commonparameters

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:Wi

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.