SafeArrayGetUBound - OLE Programmer's Reference (ole.hlp)

SafeArrayGetUBound

psa, nDim, plUbound)
SAFEARRAY FAR* psa
unsigned int nDim
long FAR* plUbound

Returns the upper bound for any dimension of a safe array.

Parameters
psa
Pointer to an array descriptor created by SafeArrayCreate().

nDim
The array dimension for which to get the upper bound.

plUbound
Pointer to the location to return the upper bound.

Return Value
The SCODE obtained from the returned HRESULT is one of the following:

SCODE	Meaning
S_OK	Success.
DISP_E_BADINDEX	The specified index is out of bounds.
E_INVALIDARG	One of the arguments is invalid.

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 = SafeArrayGetUBound(psa, 1, &lBound);

if(FAILED(hresult))

goto LError0;

. // Code omitted

LError0:;

penum->Release();

return hresult;

}

More Online Helps