Important: |
---|
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist. |
A version of this page is also available for
4/8/2010
This function retrieves the upper bound for any dimension of a safearray.
Syntax
HRESULT SafeArrayGetUBound( SAFEARRAY FAR* psa, unsigned int nDim, long FAR* plUbound ); |
Parameters
- psa
-
[in] Pointer to an array descriptor created by SafeArrayCreate.
- nDim
-
[in] Specifies the array dimension to get the upper bound for.
- plUbound
-
[out] Pointer to the location to return the upper bound.
Return Value
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
Copy Code | |
---|---|
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 = SafeArrayGetUBound(psa, 1, &lBound); if(FAILED(hresult)) goto LError0; // Code omitted here for brevity. LError0:; penum->Release(); return hresult; } |
Requirements
Header | oleauto.h |
Library | oleaut32.lib |
Windows Embedded CE | Windows CE 2.0 and later |
Windows Mobile | Windows Mobile Version 5.0 and later |