Parameter-Element (CSDL)
Das Parameter-Element in konzeptioneller Schemadefinitionssprache (CSDL) kann ein untergeordnetes Element des FunctionImport-Elements oder des Function-Elements sein.
FunctionImport-Element-Anwendung
Ein Parameter-Element (als untergeordnetes Element des FunctionImport-Elements) wird verwendet, um Eingabe- und Ausgabeparameter für Funktionsimporte zu definieren, die in CSDL deklariert werden.
Das Parameter-Element kann die folgenden untergeordneten Elemente aufweisen (der vorliegenden Reihenfolge entsprechend):
Dokumentation (kein (null oder ein Element zugelassen)
Anmerkungselemente (kein (null) Element oder mehrere Elemente zugelassen)
Anwendbare Attribute
In der folgenden Tabelle werden die Attribute beschrieben, die für das Parameter-Element übernommen werden können.
Attributname | Ist erforderlich | Wert |
---|---|---|
Name |
Ja |
Der Name des Parameters. |
Type |
Ja |
Der Typ des Parameters. Der Wert muss ein EDMSimpleType oder ein komplexer Typ sein, der sich innerhalb des Bereichs des Modells befindet. Weitere Informationen finden Sie unter Konzeptionelle Modelltypen. |
Mode |
Nein |
Die Verwendung von In, Out oder InOut ist abhängig davon, ob der Parameter ein Eingabe-, Ausgabe- oder Eingabe/Ausgabeparameter ist. |
MaxLength |
Nein |
Die maximal zulässige Länge des Parameters. |
Precision |
Nein |
Die Genauigkeit des Parameters. |
Scale |
Nein |
Die Skalierung des Parameters. |
Hinweis: |
---|
Eine beliebige Anzahl von Anmerkungsattributen (benutzerdefinierte XML-Attribute) kann für das Parameter-Element übernommen werden.Benutzerdefinierte Attribute dürfen jedoch zu keinem XML-Namespace gehören, der für CSDL reserviert ist.Die vollqualifizierten Namen für zwei benutzerdefinierte Attribute dürfen nicht übereinstimmen. |
Beispiel
Im folgenden Beispiel wird ein FunctionImport-Element mit einem untergeordneten Parameter-Element dargestellt. Die Funktion akzeptiert einen Eingabeparameter und gibt eine Auflistung von Entitätstypen zurück.
<FunctionImport Name="GetStudentGrades"
EntitySet="StudentGrade"
ReturnType="Collection(SchoolModel.StudentGrade)">
<Parameter Name="StudentID" Mode="In" Type="Int32" />
</FunctionImport>
Function-Element-Anwendung
Ein Parameter-Element (als untergeordnetes Element des Function-Elements) definiert Parameter für Funktionen, die definiert oder in einem konzeptionellen Modell deklariert sind.
Das Parameter-Element kann die folgenden untergeordneten Elemente aufweisen (der vorliegenden Reihenfolge entsprechend):
Documentation (kein (null) oder ein Element)
CollectionType (kein (null) oder ein Element)
ReferenceType (kein (null) oder ein Element)
RowType (kein (null) oder ein Element)
Hinweis: |
---|
Nur eines der CollectionType-, ReferenceType- oder RowType-Elemente kann ein untergeordnetes Element eines Property-Elements sein. |
- Anmerkungselemente (kein (null) Element oder mehrere Elemente zugelassen)
Hinweis: |
---|
Anmerkungselemente müssen an alle anderen untergeordneten Elemente angereiht werden.Anmerkungselemente sind nur in konzeptionellen Modellen für Anwendungen zulässig, die auf .NET Framework, Version 4 oder später, abzielen.Der XML-Namespace für diese Modelle ist https://schemas.microsoft.com/ado/2008/09/edm. |
Anwendbare Attribute
In der folgenden Tabelle werden die Attribute beschrieben, die für das Parameter-Element übernommen werden können.
Attributname | Ist erforderlich | Wert |
---|---|---|
Name |
Ja |
Der Name des Parameters. |
Type |
Nein |
Der Typ des Parameters. Ein Parameter kann einer der folgenden Typen (oder Auflistungen dieser Typen) sein:
Weitere Informationen zu diesen Typen finden Sie unter Konzeptionelle Modelltypen. |
Nullable |
Nein |
True (Standardwert) oder False, je nach dem, ob die Eigenschaft über einen NULL-Wert verfügen kann. |
DefaultValue |
Nein |
Der Standardwert der Eigenschaft. |
MaxLength |
Nein |
Die maximale Länge des Eigenschaftswerts. |
FixedLength |
Nein |
True oder False, abhängig davon, ob der Eigenschaftswert als Zeichenfolge mit fester Länge gespeichert wird. |
Precision |
Nein |
Die Genauigkeit des Eigenschaftswerts. |
Scale |
Nein |
Die Skalierung des Eigenschaftswerts. |
Unicode |
Nein |
True oder False, abhängig davon, ob der Eigenschaftswert als Unicode-Zeichenfolge gespeichert wird. |
Collation |
Nein |
Eine Zeichenfolge, die die Sortierreihenfolge angibt, die in der Datenquelle verwendet werden soll. |
Hinweis: |
---|
Eine beliebige Anzahl von Anmerkungsattributen (benutzerdefinierte XML-Attribute) kann für das Parameter-Element übernommen werden.Benutzerdefinierte Attribute dürfen jedoch zu keinem XML-Namespace gehören, der für CSDL reserviert ist.Die vollqualifizierten Namen für zwei benutzerdefinierte Attribute dürfen nicht übereinstimmen. |
Beispiel
Das folgende Beispiel zeigt ein Function-Element, das ein untergeordnetes Parameter-Element verwendet, um einen Funktionsparameter zu definieren.
<Function Name="GetYearsEmployed" ReturnType="Edm.Int32">
<Parameter Name="Instructor" Type="SchoolModel.Person" />
<DefiningExpression>
Year(CurrentDateTime()) - Year(cast(Instructor.HireDate as DateTime))
</DefiningExpression>
</Function>
Siehe auch
Konzepte
Übersicht über das Entity Framework
CSDL-Spezifikation
EntityContainer-Element (CSDL)
Weitere Ressourcen
CSDL-, SSDL- und MSL-Spezifikationen
ADO.NET Entity Data Model Tools
How to: Import a Stored Procedure
How to: Define Custom Functions in the Conceptual Model