SafeArrayGetDim (Windows CE 5.0)

Send Feedback

This function retrieves the number of dimensions in the array.

HRESULT SafeArrayGetDim(SAFEARRAY FAR* psa );

Parameters

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

Return Values

Returns an HRESULT value.

Remarks

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

Example

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.

}

Requirements

OS Versions: Windows CE 2.0 and later.
Header: Oleauto.h.
Link Library: Oleaut32.lib.

See Also

Automation Functions | SafeArrayCreate

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.