SafeArrayGetDim

Windows Mobile 6.5
A version of this page is also available for
4/8/2010

This function retrieves the number of dimensions in the array.


HRESULT SafeArrayGetDim( 
  SAFEARRAY FAR* psa 
);

psa

[in] Pointer to an array descriptor created by SafeArrayCreate.

Returns an HRESULT value.

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

HRESULT
CEnumPoint::Create(SAFEARRAY FAR* psa, CEnumPoint FAR* FAR* ppenum)
{
  long lBound;
  HRESULT hresult;
  CEnumPoint FAR* penum;
  // Verify that the SafeArray is the proper shape.
  if(SafeArrayGetDim(psa) != 1)
    return ReportResult(0, E_INVALIDARG, 0, 0);
  // Code omitted here for brevity.
}

Headeroleauto.h
Libraryoleaut32.lib
Windows Embedded CEWindows CE 2.0 and later
Windows MobileWindows Mobile Version 5.0 and later

Community Additions

Show: