Parameter (Elemento) (CSDL)
En el lenguaje de definición de esquemas conceptuales (CSDL), el elemento Parameter puede ser un elemento secundario del elemento FunctionImport o del elemento Function.
Aplicación para el elemento FunctionImport
El elemento Parameter (como elemento secundario del elemento FunctionImport) se usa para definir los parámetros de entrada y de salida de las importaciones de funciones declaradas en CSDL.
El elemento Parameter puede tener los elementos secundarios siguientes (en el orden mostrado):
Documentation (cero o un elemento)
Elementos Annotation (cero o más elementos)
Atributos aplicables
En la tabla siguiente se describen los atributos que se pueden aplicar al elemento Parameter.
| Nombre de atributo | Es necesario | Valor |
|---|---|---|
Name |
Sí |
Nombre del parámetro. |
Type |
Sí |
Tipo del parámetro. El valor debe ser un tipo EDMSimpleType o un tipo complejo que se encuentre dentro del ámbito del modelo. Para obtener más información, vea Tipos de modelos conceptuales. |
Mode |
No |
In, Out o InOut dependiendo de si el parámetro es de entrada, de salida o de entrada/salida. |
MaxLength |
No |
Longitud máxima permitida del parámetro. |
Precision |
No |
Precisión del parámetro. |
Scale |
No |
Escala del parámetro. |
.gif "Ee473431.note(es-es,VS.100).gif") Nota: |
|---|
| Se puede aplicar cualquier número de atributos de anotación (atributos XML personalizados) al elemento Parameter.Sin embargo, es posible que los atributos personalizados no pertenezcan a ningún espacio de nombres XML reservado para CSDL.Dos atributos personalizados cualesquiera no pueden tener nombres completos idénticos. |
Ejemplo
En el ejemplo siguiente se muestra un elemento FunctionImport con un elemento Parameter secundario. La función acepta un parámetro de entrada y devuelve una colección de tipos de entidad.
<FunctionImport Name="GetStudentGrades"
EntitySet="StudentGrade"
ReturnType="Collection(SchoolModel.StudentGrade)">
<Parameter Name="StudentID" Mode="In" Type="Int32" />
</FunctionImport>
Aplicación para el elemento Function
Un elemento Parameter (como un elemento secundario del elemento Function) define los parámetros para las funciones que se definen o se declaran en un modelo conceptual.
El elemento Parameter puede tener los elementos secundarios siguientes (en el orden mostrado):
Documentation (cero o un elemento)
CollectionType (cero o un elemento)
ReferenceType (cero o un elemento)
RowType (cero o un elemento)
| Nota: |
|---|
| Solo uno de los elementos CollectionType, ReferenceType y RowType puede ser secundario de un elemento Property. |
- Elementos Annotation (cero o más elementos)
| Nota: |
|---|
| Los elementos de anotación deben aparecer después de todos los demás elementos secundarios.Los elementos de anotación solo se pueden emplear en modelos conceptuales en aquellas aplicaciones diseñadas para la versión 4 o posterior de .NET Framework.El espacio de nombres XML para dichos modelos es https://schemas.microsoft.com/ado/2008/09/edm. |
Atributos aplicables
En la tabla siguiente se describen los atributos que se pueden aplicar al elemento Parameter.
| Nombre de atributo | Es necesario | Valor |
|---|---|---|
Name |
Sí |
Nombre del parámetro. |
Type |
No |
Tipo del parámetro. Un parámetro puede ser de cualquiera de los siguientes tipos (o colecciones de estos tipos):
Para obtener más información sobre estos tipos, vea Tipos de modelos conceptuales. |
Nullable |
No |
True (el valor predeterminado) o False dependiendo de si la propiedad puede tener un valor null. |
DefaultValue |
No |
Valor predeterminado de la propiedad. |
MaxLength |
No |
Longitud máxima del valor de propiedad. |
FixedLength |
No |
True o False dependiendo de si el valor de propiedad se va a almacenar como una cadena de longitud fija. |
Precision |
No |
Precisión del valor de propiedad. |
Scale |
No |
Escala del valor de propiedad. |
Unicode |
No |
True o False dependiendo de si el valor de propiedad se va a almacenar como una cadena Unicode. |
Collation |
No |
Cadena que especifica la secuencia de intercalación que se va a usar en el origen de datos. |
| Nota: |
|---|
| Se puede aplicar cualquier número de atributos de anotación (atributos XML personalizados) al elemento Parameter.Sin embargo, es posible que los atributos personalizados no pertenezcan a ningún espacio de nombres XML reservado para CSDL.Dos atributos personalizados cualesquiera no pueden tener nombres completos idénticos. |
Ejemplo
En el ejemplo siguiente se muestra un elemento Function que usa un elemento secundario Parameter para definir un parámetro de una función.
<Function Name="GetYearsEmployed" ReturnType="Edm.Int32">
<Parameter Name="Instructor" Type="SchoolModel.Person" />
<DefiningExpression>
Year(CurrentDateTime()) - Year(cast(Instructor.HireDate as DateTime))
</DefiningExpression>
</Function>
Vea también
Conceptos
Información general de Entity Framework
Especificación CSDL
EntityContainer (Elemento) (CSDL)
Otros recursos
Especificaciones CSDL, SSDL y MSL
ADO.NET Entity Data Model Tools
How to: Import a Stored Procedure
How to: Define Custom Functions in the Conceptual Model