SafeArrayGetDim (Compact 2013)
3/26/2014
This function retrieves the number of dimensions in the array.
Syntax
HRESULT SafeArrayGetDim(
SAFEARRAY FAR* psa
);
Parameters
- psa
[in] Pointer to an array descriptor created by SafeArrayCreate.
Return Value
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
Header |
oleauto.h |
Library |
oleaut32.lib |