System.VarUtils.SafeArrayLock

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi

function SafeArrayLock; external oleaut name 'SafeArrayLock';

Propriétés

Type Visibilité  Source Unité  Parent
function external public System.VarUtils.pas System.VarUtils System.VarUtils

Description

Verrouille un tableau sécurisé.

SafeArrayLock verrouille le tableau sécurisé donné dans le paramètre VarArray. VarArray est un pointeur sur le tableau sécurisé.

Les valeurs de retour possibles de SafeArrayLock sont listées dans le tableau suivant, ainsi que leur signification.



Valeur Signification

VAR_OK

L'opération s'est terminée avec succès.

VAR_INVALIDARG

L'argument donné est nil.

VAR_ARRAYISLOCKED

Le tableau donné dans VarArray est verrouillé.



Quand il est verrouillé, un tableau sécurisé ne peut pas être redimensionné et tout appel à SafeArrayRedim échoue. Dès qu'il est verrouillé, un tableau sécurisé doit être déverrouillé ultérieurement à l'aide de SafeArrayUnlock.

Si l'opération de verrouillage a réussi, VarArray pointe sur un tableau d'éléments dans lequel la dimension la plus à gauche augmente en premier. Autrement dit, les dimensions du pointeur de tableau renvoyé sont inversées par rapport à celles du tableau sécurisé.

Conseil :  Une fois que SafeArrayLock a vérifié que le tableau sécurisé a les bonnes limites et dimensions, SafeArrayLock peut être utilisée pour accéder directement aux données du tableau qui permet aussi un gain de performances.

Voir aussi