SafeArrayGetLBound (Windows CE 5.0)
This function retrieves the lower bound for any dimension of a safearray.
HRESULT SafeArrayGetLBound(SAFEARRAY FAR* psa,unsigned intnDim,long FAR* plLbound );
Parameters
- psa
[in] Pointer to an array descriptor created by SafeArrayCreate. - nDim
[in] Specifies the array dimension to get the lower bound for. - plLbound
[out] Pointer to the location to return the lower bound.
Return Values
Returns the HRESULT values shown in the following table.
Value | Description |
---|---|
S_OK | Success. |
DISP_E_BADINDEX | The specified index is out of bounds. |
E_INVALIDARG | An argument is invalid. |
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.
HRESULT = SafeArrayGetLBound(psa, 1, &lBound);
if(FAILED(hresult))
return hresult;
// 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