Share via


SafeArrayLock (Windows Embedded CE 6.0)

1/6/2010

This function increments the lock count of an array, and places a pointer to the array data in pvData of the array descriptor.

Syntax

HRESULT SafeArrayLock(
  SAFEARRAY FAR* psa 
);

Parameters

Return Value

Returns the HRESULT values shown in the following table.

Value Description

S_OK

Success.

E_INVALIDARG

The psa parameter was not a valid safearray descriptor.

E_UNEXPECTED

The array could not be locked.

Remarks

The pointer in the array descriptor is valid until SafeArrayUnlock is called.

Calls to SafeArrayLock can be nested. An equal number of calls to SafeArrayUnlock are required.

Passing invalid (and under some circumstances NULL) pointers to this function causes an unexpected termination of the application.

An array cannot be deleted while it is locked.

Requirements

Header oleauto.h
Library oleaut32.lib
Windows Embedded CE Windows CE 2.0 and later

See Also

Reference

Automation Functions
SafeArrayCreate