GetScreen

La méthode GetScreen remplit un tampon fourni par l'application avec les données du champ. Le type de données copiées dans le tampon est sélectionné avec le paramètre facultatif Plane. La valeur par défaut est de renvoyer les données du plan de texte. Les données renvoyées correspondent au champ tel qu'il existait au moment de la création de cet objet champ, elles ne refléteront pas le contenu actuel du champ s'il a été mis à jour depuis l'appel de la fonction ECLFieldList::Refresh.

La longueur des données renvoyées est la longueur du champ (voir GetLength). Lorsque la valeur TextPlane est copiée, un octet de fin nul supplémentaire est ajouté après le dernier octet de données. Par conséquent, l’application doit fournir un tampon d’au moins 1 octet de plus que la longueur du champ lors de l’obtention du plan de texte. Si le tampon de l'application est trop petit, les données renvoyées sont tronquées. Le nombre d'octets copiés dans le tampon d'application est renvoyé comme résultat de la fonction (sans compter le terminateur Null pour les copies du plan de texte).

La valeur FieldPlane ne peut pas être obtenue avec cette fonction. ECLField::GetAttribute peut être utilisé pour obtenir la valeur de l’attribut de champ.