SafeArrayPtrOfIndex (Compact 2013)

3/26/2014

This function retrieves a pointer to an array element.

Syntax

HRESULT SafeArrayPtrOfIndex(
  SAFEARRAY FAR* psa, 
  long FAR* rgIndices, 
  void HUGEP* FAR* ppvData 
);

rgIndices
Array of index values that identify an element of the array. All indexes for the element must be specified.

ppvData
On return, pointer to the void pointer to the element identified by the values in rgIndices.

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.
DISP_E_BADINDEX	The specified index was invalid.

The array should be locked before SafeArrayPtrOfIndex is called. Failing to lock the array can cause unpredictable results.

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

Header	oleauto.h
Library	oleaut32.lib