Data.DB.TDataSet.MoveBy

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi

function MoveBy(Distance: Integer): Integer; virtual;

C++

virtual int __fastcall MoveBy(int Distance);

Propriétés

Type Visibilité  Source Unité  Parent
function public
Data.DB.pas
Data.DB.hpp
Data.DB TDataSet

Description

Effectue un déplacement sur un enregistrement relatif à l'enregistrement actif de l'ensemble de données.

Appelez MoveBy pour déplacer l'enregistrement actif du nombre d'enregistrements spécifié par Distance. Si la valeur de Distance est positive, le déplacement doit se faire en avant dans l'ensemble de données, une valeur négative indique un déplacement en arrière. Par exemple, l'instruction suivante déplace le curseur de dix enregistrements en arrière :



MoveBy(-10);



DataSet1->MoveBy(-10);



MoveBy expédie les modifications de l'enregistrement actif et :

Définit les propriétés Bof et Eof sur false.

Si la valeur de Distance est positive, lit le nombre approprié d'enregistrements suivants (si possible), et rend actif le dernier enregistrement lu. Si cela entraîne un déplacement au-delà de la fin du fichier, MoveBy affecte la valeur true à Eof.

Si la valeur de Distance est négative, lit le nombre approprié d'enregistrements précédents (si possible), et rend actif le dernier enregistrement lu. Si cela entraîne un déplacement au-delà du début du fichier, MoveBy affecte la valeur true à Bof. Si l'ensemble de données est unidirectionnel, il déclenche une exception EDatabaseError quand MoveBy tente de lire un enregistrement précédent.

Diffuse les informations sur le changement d'enregistrement afin que les contrôles orientés données et les ensembles de données liés puissent être actualisés.

Renvoie le nombre d'enregistrements déplacés. Le plus souvent, Result correspond à la valeur absolue de Distance, sauf si MoveBy a rencontré l'une des extrémités du fichier avant de se déplacer de Distance enregistrements. Dans ce cas, Result est inférieur à la valeur absolue de Distance.

Voir aussi