SafeArrayGetLBound (Compact 2013)

Article
11/04/2015

3/26/2014

This function retrieves the lower bound for any dimension of a safearray.

Syntax

HRESULT SafeArrayGetLBound(
  SAFEARRAY FAR* psa, 
  unsigned int nDim, 
  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 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

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

Header	oleauto.h
Library	oleaut32.lib

Share via