New-SPExcelUserDefinedFunction

  • Referenz
Modul:
SharePointServer
Gilt für::
SharePoint Server 2010, SharePoint Server 2013

Fügt der Excel Services-Anwendung eine neue benutzerdefinierte Funktion hinzu.

Syntax

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

Beschreibung

Das New-SPExcelUserDefinedFunction Cmdlet fügt einer Excel Services Application-Webdienstanwendung eine benutzerdefinierte Funktion hinzu. Excel Services Anwendung verwendet nur benutzerdefinierte Funktionen, die einen Eintrag in der Liste der benutzerdefinierten Funktionen enthalten. Benutzerdefinierte Funktionen sind verwaltete Codeassemblys, die mithilfe der standardmäßigen Excel Services Anwendungsformelsyntax aus einer Excel Services Application-Arbeitsmappe aufgerufen werden können. Die Assemblys können benutzerdefinierte Logik oder andere Aktionen, wie z. B. Datenaktualisierung, ausführen. Windows PowerShell Cmdlets arbeiten mit den Einträgen, die in der Liste der benutzerdefinierten Funktionen enthalten sind, aber nicht für die Assemblys.

Informationen zu Berechtigungen sowie Aktuelles zu Windows PowerShell für SharePoint-Produkte finden Sie in der Onlinedokumentation unter SharePoint Server-Cmdlets.

Beispiele

--------------------BEISPIEL--------------------

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

In diesem Beispiel wird jeder Excel Services Application-Webdienstanwendung in der Farm die Datei SampleComany.SampleApplication.SampleUdf hinzugefügt.

Die benutzerdefinierte Funktionsassembly wird im globalen Assemblycache (GAC) bereitgestellt.

Parameter

-Assembly

Gibt den stark typisierten Namen der Assembly an. Der Name muss in der Liste der benutzerdefinierten Funktionen eindeutig sein. Die maximale Länge beträgt 4096 alphanumerische Zeichen.

Der Typ muss eine Zeichenfolge alphanumerischer Zeichen sein. Zum Beispiel:

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

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013

-AssemblyLocation

Gibt den Speicherort an, an dem die Assembly gespeichert ist. Der Standardwert ist GAC.

Der Typ muss einer der folgenden Werte sein: GAC oder LocalFile.

Type:AssemblyLocation
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013

-AssignmentCollection

Verwaltet Objekte zum Zweck der ordnungsgemäßen Beseitigung. Die Verwendung von Objekten wie beispielsweise SPWeb oder SPSite kann sehr viel Arbeitsspeicher erfordern, und für die Verwendung dieser Objekte in Windows PowerShell-Skripts muss der Arbeitsspeicher entsprechend verwaltet werden. Mit dem SPAssignment-Objekt können Sie einer Variablen Objekte zuweisen und die Objekte beseitigen, wenn sie nicht mehr benötigt werden, um Arbeitsspeicher freizugeben. Wenn die Objekte SPWeb, SPSite oder SPSiteAdministration verwendet werden, werden diese automatisch beseitigt, falls keine Zuweisungsauflistung oder kein Global-Parameter verwendet wird.

Wenn der Global-Parameter verwendet wird, sind alle Objekte im globalen Speicher enthalten. Es kann vorkommen, dass nicht genügend Arbeitsspeicher vorhanden ist, falls Objekte nicht sofort verwendet werden oder mit dem Befehl Stop-SPAssignment beseitigt werden.

Type:SPAssignmentCollection
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013

-Confirm

Fordert Sie zum Bestätigen auf, bevor der Befehl ausgeführt wird. Um weitere Informationen zu erhalten, geben Sie den folgenden Befehl ein: get-help about_commonparameters

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013

-Description

Gibt eine benutzerfreundliche Beschreibung für die benutzerdefinierte Funktion an. Die maximale Länge beträgt 4096 alphanumerische Zeichen. Der Standardwert ist eine leere Zeichenfolge.

Der Typ muss eine gültige Zeichenfolge alphanumerischer Zeichen sein. Dies ist beispielsweise die benutzerdefinierte Funktion für Konsolidierungsberichte.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013

-Enable

Aktiviert die benutzerdefinierte Funktion für die Verwendung mit Excel Services Application. Der Standardwert lautet "True".

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013

-ExcelServiceApplication

Gibt die Excel Services Anwendungswebdienstanwendung an, die die Liste der benutzerdefinierten Funktionen enthält.

Der Typ muss eine gültige GUID im Format 12345678-90ab-cdef-1234-567890bcdefgh sein; ein gültiger Name einer Excel Services Application-Webdienstanwendung in der Farm (z. B. MyExcelService1) oder eine Instanz eines gültigen SPExcelServiceApplication-Objekts.

Type:SPExcelServiceApplicationPipeBind
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013

-WhatIf

Zeigt eine Meldung an, die die Auswirkung des Befehls beschreibt, anstatt den Befehl auszuführen. Um weitere Informationen zu erhalten, geben Sie den folgenden Befehl ein: get-help about_commonparameters

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013