Set-SPExcelUserDefinedFunction

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

Legt Eigenschaften einer benutzerdefinierten Funktion in einer Excel Services-Anwendung fest.

Syntax

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

Beschreibung

Das Set-SPExcelUserDefinedFunction Cmdlet legt Eigenschaften einer benutzerdefinierten Funktionsassembly fest. Excel Services Application verwendet nur benutzerdefinierte Funktionen, die über einen Eintrag in der Liste der benutzerdefinierten Funktionen verfügen. 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. Zum Ausführen der Windows PowerShell-Cmdlets werden die Einträge in der Liste der benutzerdefinierten Funktionen verwendet, nicht 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 1--------------

Set-SPExcelUserDefinedFunction -ExcelServiceApplication "My Excel Service" -Identity SampleCompany.SampleApplication.SampleUdf -Description "This is the new description for the sample UDF"

In diesem Beispiel wird die Beschreibung der benutzerdefinierten Funktion (UDF) in die UDF-Datei SampleCompany.SampleApplication.SampleUdf für die Excel Services Application-Webdienstanwendung mit dem Namen Mein Excel-Dienst geändert.

--------------BEISPIEL 2--------------

Get-SPExcelServiceApplication "My Excel Service" | Set-SPExcelUserDefinedFunction -Identity SampleCompany.SampleApplication.SampleUdf -Enable: $false

In diesem Beispiel wird die UDF-Beispieldatei SampleCompany.SampleApplication.SampleUdf aus der Excel Services Application namens My Excel Service deaktiviert.

Parameter

-Assembly

Gibt den stark typisierten Namen der Assembly an. Der Name muss in der Liste der benutzerdefinierten Funktionen eindeutig sein und darf maximal 4.096 alphanumerische Zeichen lang sein.

Der Typ muss eine Zeichenfolge aus alphanumerischen Zeichen sein, z. B. BeispielUnternehmen, BeispielAnwendung, BeispielUDF, C:\UDFs\SampleUdf.dll oder \\MeinNetzwerkServer\UDFs\SampleUdf.dll.

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

-AssemblyLocation

Gibt den Speicherort an, an dem die Assembly gespeichert ist.

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 Anzeigebeschreibung für die benutzerdefinierte Funktion an. Der Name darf nicht länger als 4096 alphanumerische Zeichen sein.

Der Typ muss eine aus alphanumerischen Zeichen bestehende Zeichenfolge sein, z. B.: "Dies ist 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.

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 Application-Webdienstanwendung an, die das SPExcelUserDefinedFunction-Listenobjekt 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

-Identity

Gibt das zu aktualisierende SPExcelUserDefinedFunction-Objekt an.

Der Typ muss ein gültiger Name der Codeassembly sein. Beispiel: SampleCompany.SampleApplication.SampleUdf; oder eine Instanz eines gültigen SPExcelUDF-Objekts.

Type:SPExcelUDFPipeBind
Position:1
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