System.VarUtils.SafeArrayLock

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

function SafeArrayLock; external oleaut name 'SafeArrayLock';

Eigenschaften

Typ Sichtbarkeit Quelle Unit Übergeordnet
function external public System.VarUtils.pas System.VarUtils System.VarUtils

Beschreibung

Sperrt ein sicheres Array.

SafeArrayLock sperrt das im Parameter VarArray angegebene sichere Array. VarArray ist ein Zeiger auf das sichere Array.

Die möglichen Rückgabewerte von SafeArrayLock sind zusammen mit ihrer Bedeutung in der folgenden Tabelle aufgeführt.



Wert Bedeutung

VAR_OK

Die Operation wurde erfolgreich abgeschlossen.

VAR_INVALIDARG

Das gegebene Argument ist nil.

VAR_ARRAYISLOCKED

Das in VarArray angegebene Array ist gesperrt.



Während ein sicheres Array gesperrt ist, kann seine Größe nicht geändert werden, und alle Aufrufe von SafeArrayRedim schlagen fehl. Ein gesperrtes sicheres Array muss mit SafeArrayUnlock entsperrt werden.

Wenn die Sperr-Operation erfolgreich war, zeigt VarArray auf ein Array mit Elementen, in dem zuerst die erste Dimension vergrößert wird. Die Dimensionen des zurückgegebenen Array-Zeigers stellen also eine Umkehrung der Dimensionen des sicheren Arrays dar.

Tip:  Nachdem SafeArrayLock geprüft hat, ob das sichere Array die richtigen Grenzen und Dimensionen aufweist, kann mit SafeArrayLock direkt auf die Array-Daten zugegriffen und so die Leistung optimiert werden.

Siehe auch