Élément FilterDescriptor dans FilterDescriptors (schéma BDCMetadata)

S’applique à : SharePoint 2016 | SharePoint Foundation 2013 | SharePoint En ligne | SharePoint Server 2013

Spécifie un descripteur de filtre d’une méthode.

Espace de noms: http://schemas.microsoft.com/windows/2007/BusinessDataCatalog

Schéma : BDCMetadata

<FilterDescriptor Type = "String" FilterField = "String" Name = "String" DefaultDisplayName = "String" IsCached = "Boolean"> </FilterDescriptor>

Éléments et attributs

Les sections suivantes décrivent les attributs, les éléments enfants et les éléments parents.

Attributs

Attribut

Description

**Type**

Obligatoire.

Type du descripteur de filtre.

Le tableau suivant répertorie les valeurs possibles pour cet attribut.

Valeur

Description

Limite

Utilisé lors de l’interrogation d’un système externe et dont la valeur peut être interprétée en tant que limite du nombre d’éléments externes (**EntityInstances**) qui sont retournés lorsque la méthode auquel il appartient est appelée.

PageNumber

Wildcard

Utilisé lors de l’interrogation d’un système externe. Sa valeur représente un modèle de caractères ordinaires et génériques qui est comparé à la valeur d’un champ particulier de l’ensemble d’instances EntityInstances. Le système externe retourne uniquement les instances EntityInstances dont les valeurs de champ correspondent au modèle spécifié.

UserContext

Utilisé lors de l'interrogation d'un système externe. Sa valeur peut être définie automatiquement par n'importe quelle application cliente avec l'identité de l'utilisateur qui appelle le système externe. Cette valeur peut ensuite être utilisée par le système externe pour autoriser puis filtrer les résultats retournés.

UserCulture

Nom d'utilisateur

Password

LastId

SsoTicket

UserProfile

Utilisé lors de l'interrogation d'un système externe. Sa valeur peut être obtenue en examinant le profil de l'utilisateur actuel. Le système externe peut utiliser sa valeur pour filtrer les résultats retournés.

Comparison

Utilisée lors de l'interrogation d'un système externe. Un système externe peut comparer une valeur de **ComparisonFilter** avec la valeur d'un champ particulier d'un ensemble d'instances **EntityInstances**, et seules ces instances **EntityInstances** où les valeurs de champ satisfont au test de comparaison peuvent être retournées.

Horodateur (Timestamp)

Input

Utilisé lors de l'appel d'une opération dans un système externe. Un système externe peut utiliser la valeur d'un filtre **InputFilter** en tant qu'arguments supplémentaires pour l'opération.

Output

Utilisé lors de l'appel d'une opération dans un système externe. Les résultats supplémentaires d'une opération qui ne peuvent pas être capturés par **ReturnTypeDescriptor** peuvent être récupérés en tant que valeur du filtre **InputOutputFilter**.

InputOutput

Utilisé lors de l'appel d'une opération dans un système externe. Un système externe peut utiliser la valeur d'un filtre **InputOutputFilter** en tant qu'arguments supplémentaires pour l'opération, et les résultats supplémentaires d'une opération qui ne peuvent pas être capturés par **ReturnTypeDescriptor** peuvent être récupérés en tant que valeur de **InputOutputFilter**.

Batching

BatchingTermination

ActivityId

**ActivityId** est utilisé lors de l'appel d'une opération sur le système externe. Sa valeur est définie sur un GUID qui représente le contexte de l'opération en cours. Si cette valeur n'est pas disponible, ce filtre génère un GUID aléatoire. Sur SharePoint Foundation 2010, ce filtre utilise **CorrelationID**.

**FilterField**

Facultatif.

Type d'attribut : **String**

**Name**

Obligatoire.

Nom du descripteur de filtre.

Type d'attribut : **String**

**DefaultDisplayName**

Facultatif.

Nom d’affichage par défaut du descripteur de filtre.

Type d'attribut : **String**

**IsCached**

Facultatif.

Spécifie si ce descripteur de filtre est utilisé fréquemment. Si sa valeur est définie à **true**, Service Business Data Connectivity (BDC) met en cache ce descripteur de filtre dans la mémoire.

Valeur par défaut : **true**

Type d'attribut : **Boolean**

Éléments enfants

Élément

Description

LocalizedDisplayNames, élément dans MetadataObject (schéma BDCMetadata)

Les noms d’affichage localisés de ce descripteur de filtre.

Properties, élément dans MetadataObject (schéma BDCMetadata)

Les propriétés de ce descripteur de filtre.

Éléments parents

Élément

Description

Élément FilterDescriptors dans Methods (schéma BDCMetadata)

Une liste des descripteurs de filtre d’une méthode.