Compartir a través de

New-SPExcelUserDefinedFunction

Módulo:
SharePointServer module

Agrega una nueva función definida por el usuario a la aplicación de Servicios de Excel.

Sintaxis

Default (Es el valor predeterminado). 

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

Description

El New-SPExcelUserDefinedFunction cmdlet agrega una función definida por el usuario a una aplicación de servicio web de aplicación Excel Services. Excel Services Aplicación solo usa funciones definidas por el usuario que tienen una entrada en la lista de funciones definidas por el usuario. Las funciones definidas por el usuario son ensamblados de código administrado a los que se puede llamar desde un libro de aplicación de Excel Services mediante la sintaxis de fórmula de aplicación Excel Services estándar. Los ensamblados pueden realizar acciones lógicas personalizadas u otras, como actualizar datos. Los cmdlet de Windows PowerShell funcionan en las entradas de la lista de funciones definidas por el usuario pero no en los ensamblados.

Para obtener permisos y la información más reciente acerca de Windows PowerShell para Productos de SharePoint, vea la documentación en línea en Cmdlets de SharePoint Server.

Ejemplos

EJEMPLO

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

En este ejemplo se agrega el archivo SampleComany.SampleApplication.SampleUdf a cada aplicación de servicio web de aplicación Excel Services de la granja de servidores.

El ensamblado de funciones definidas por el usuario se implementa en la memoria caché de ensamblado global (GAC).

Parámetros

-Assembly

Aplicable: SharePoint Server 2010, SharePoint Server 2013

Especifica el nombre de tipo estricto del ensamblado. El nombre debe ser único en la lista de funciones definidas por el usuario. El nombre puede contener 4096 caracteres alfanuméricos como máximo.

El tipo debe ser una cadena de caracteres alfanuméricos; por ejemplo:

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

Propiedades del parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-AssemblyLocation

Aplicable: SharePoint Server 2010, SharePoint Server 2013

Especifica la ubicación donde se guarda el ensamblado. El valor predeterminado es GAC.

El tipo debe ser uno de los siguientes: GAC o LocalFile.

Propiedades del parámetro

Tipo:AssemblyLocation
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-AssignmentCollection

Aplicable: SharePoint Server 2010, SharePoint Server 2013

Administra objetos para su correcta eliminación. El uso de objetos como SPWeb o SPSite puede requerir una gran cantidad de memoria y su uso en scripts de Windows PowerShell requiere una administración adecuada de la memoria. Mediante el uso del objeto SPAssignment se pueden asignar objetos a una variable y eliminar los objetos cuando ya no sean necesarios para liberar memoria. Cuando se usan los objetos SPWeb, SPSite o SPSiteAdministration, los objetos se eliminan automáticamente si no se usa una colección de asignaciones o el parámetro Global.

Cuando se usa el parámetro Global, todos los objetos se guardan en el almacén global. Si los objetos no se usan de forma inmediata o se eliminan mediante el comando Stop-SPAssignment, puede producirse un error de memoria insuficiente.

Propiedades del parámetro

Tipo:SPAssignmentCollection
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Confirm

Aplicable: SharePoint Server 2010, SharePoint Server 2013

Le pide confirmación antes de ejecutar el comando. Para obtener más información, escriba el siguiente comando: get-help about_commonparameters

Propiedades del parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:cf

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Description

Aplicable: SharePoint Server 2010, SharePoint Server 2013

Especifica la descripción simplificada de la función definida por el usuario. El nombre puede contener 4096 caracteres alfanuméricos como máximo. El valor predeterminado es una cadena vacía.

El tipo debe ser una cadena válida de caracteres alfanuméricos; por ejemplo, "Ésta es la función definida por el usuario para informes de consolidación".

Propiedades del parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Enable

Aplicable: SharePoint Server 2010, SharePoint Server 2013

Activa la función definida por el usuario para su uso con Excel Services Application. El valor predeterminado es True.

Propiedades del parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-ExcelServiceApplication

Aplicable: SharePoint Server 2010, SharePoint Server 2013

Especifica la aplicación de servicio web de aplicación Excel Services que contiene la lista de funciones definidas por el usuario.

El tipo debe ser un GUID válido, con el formato 12345678-90ab-cdef-1234-567890bcdefgh; un nombre válido de una aplicación de servicio web de aplicación de Excel Services en la granja de servidores (por ejemplo, MyExcelService1); o una instancia de un objeto SPExcelServiceApplication válido.

Propiedades del parámetro

Tipo:SPExcelServiceApplicationPipeBind
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-WhatIf

Aplicable: SharePoint Server 2010, SharePoint Server 2013

Muestra un mensaje que describe el efecto del comando en lugar de ejecutar dicho comando. Para obtener más información, escriba el siguiente comando: get-help about_commonparameters

Propiedades del parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:Wi

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para más información, consulte about_CommonParameters.