Get-SPExcelUserDefinedFunction
Retorna uma função definida pelo usuário ou um conjunto de funções definidas pelo usuário.
Sintaxe
Default (Default)
Get-SPExcelUserDefinedFunction
[[-Identity] <SPExcelUDFPipeBind>]
-ExcelServiceApplication <SPExcelServiceApplicationPipeBind>
[-AssignmentCollection <SPAssignmentCollection>]
[<CommonParameters>]
Description
O cmdlet Get-SPExcelUserDefinedFunction lê uma função definida pelo usuário e suas propriedades ou retorna a coleção de funções definidas pelo usuário para um aplicativo de serviço Web do aplicativo Serviços do Excel. O Aplicativo de Serviços do Excel usa apenas funções definidas pelo usuário que estão na lista de funções definidas pelo usuário. As funções definidas pelo usuário são assemblies de código gerenciados que podem ser chamados de uma pasta de trabalho do Aplicativo de Serviços do Excel usando a sintaxe de fórmula padrão do Aplicativo de Serviços do Excel. Os assemblies podem executar ações lógicas personalizadas ou outras ações, como atualizar dados. Os cmdlets do Windows PowerShell operam nas entradas na lista de funções de definidas pelo usuário, mas não nos assemblies.
Para obter as permissões e informações mais recentes sobre o Windows PowerShell para Produtos SharePoint, confira a documentação online em Cmdlets do SharePoint Server.
Exemplos
EXEMPLO 1
Get-SPExcelServiceApplication -Identity "MyExcelService" | Get-SPExcelUserDefinedFunction -Identity SampleCompany.SampleApplication.SampleUdf
Este exemplo exibe a função definida pelo usuário denominada SampleCompany.SampleApplication.SampleUdf da lista de funções definidas pelo usuário que está no aplicativo de serviço Web do Aplicativo de Serviços do Excel denominado MyExcelService.
EXEMPLO 2
Get-SPExcelServiceApplication | Get-SPExcelUserDefinedFunction | format-list
Este exemplo exibe todas as funções definidas pelo usuário para cada aplicativo de serviço Web do aplicativo de Serviços do Excel no farm e exibe os resultados em uma lista.
Parâmetros
-AssignmentCollection
Aplicável: SharePoint Server 2010, SharePoint Server 2013
Gerencia objetos para o devido descarte. O uso de objetos como SPWeb ou SPSite pode consumir grandes quantidades de memória e o uso desses objetos em scripts do Windows PowerShell requer gerenciamento de memória adequado. Usando o objeto SPAssignment, você poderá atribuir objetos a uma variável e descartar os objetos após o uso para liberar memória. Quando objetos SPWeb, SPSite ou SPSiteAdministration são usados, os objetos são automaticamente descartados se um conjunto de atribuições ou o parâmetro Global não forem usados.
Quando o parâmetro Global é usado, todos os objetos estão contidos no repositório global. Se os objetos não forem usados imediatamente ou forem descartados usando o comando Stop-SPAssignment, um cenário de falta de memória poderá ocorrer.
Propriedades do parâmetro
| Tipo: | SPAssignmentCollection |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-ExcelServiceApplication
Aplicável: SharePoint Server 2010, SharePoint Server 2013
Especifica o aplicativo de serviços Web do aplicativo de Serviços do Excel que contém o objeto de lista SPExcelUserDefinedFunction.
O tipo deve ser um GUID válido, no formato 12345678-90ab-cdef-1234-567890bcdefgh; um nome válido de um aplicativo de serviço Web do aplicativo de Serviços do Excel no farm (por exemplo, MyExcelService1); ou uma instância de um objeto SPExcelServiceApplication válido.
Propriedades do parâmetro
| Tipo: | SPExcelServiceApplicationPipeBind |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-Identity
Aplicável: SharePoint Server 2010, SharePoint Server 2013
Especifica o objeto UserDefinedFunction a ser obtido. Se o parâmetro Identity não for especificado, o cmdlet retornará todas as funções na lista de funções definidas pelo usuário.
O tipo deve ser um nome válido do assembly de código (por exemplo, SampleCompany.SampleApplication.SampleUdf); ou uma instância de um objeto SPExcelUDF válido.
Propriedades do parâmetro
| Tipo: | SPExcelUDFPipeBind |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | 1 |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
CommonParameters
Este cmdlet dá suporte aos parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, confira about_CommonParameters.