SafeArrayGetUBound

A version of this page is also available for

Windows Embedded CE 6.0 R3

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.

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 = SafeArrayGetUBound(psa, 1, &lBound);
  if(FAILED(hresult))
    goto LError0;
  // Code omitted here for brevity.
LError0:;
  penum->Release();
  return hresult;
}

Requirements

See Also

Reference

Automation Functions
SafeArrayCreate