SafeArrayAccessData

HRESULT SafeArrayAccessData( 
  SAFEARRAY FAR*  psa,       
  void HUGEP* FAR*  ppvData  
);
 

Increments the lock count of an array, and retrieves a pointer to the array data.

Parameters

psa

Pointer to an array descriptor created by SafeArrayCreate.

ppvData

On exit, pointer to a pointer to the array data. Arrays may be larger than 64K, so very large pointers should be used only in Windows version 3.1 or later.

Return Value

The return value obtained from the returned HRESULT is one of the following.

Example

The following example sorts a safe array of one dimension that contains BSTRs by accessing the array elements directly. This approach is faster than using SafeArrayGetElement and SafeArrayPutElement.

long i, j, min; 
BSTR bstrTemp;
BSTR HUGEP *pbstr;
HRESULT hr;

// Get a pointer to the elements of the array.
hr = SafeArrayAccessData(psa, (void HUGEP* FAR*)&pbstr);
if (FAILED(hr))
goto error;

// Bubble sort.
cElements = lUBound-lLBound+1; 
for (i = 0; i < cElements-1; i++)
{
    min = i;
    for (j = i+1; j < cElements; j++)
    {
        if (wcscmp(pbstr[j], pbstr[min]) < 0)
            min = j; 
    }

    // Swap array[min] and array[i].
    bstrTemp = pbstr[min];
    pbstr[min] = pbstr[i];
    pbstr[i] = bstrTemp;

}

SafeArrayUnaccessData(psa);

QuickInfo

  Windows NT: Use version 3.1 and later.
  Windows: Use Windows 95 and later.
  Header: Declared in oleauto.h.
  Import Library: Link with oleaut32.lib.