SafeArrayRedim Function

Changes the right-most (least significant) bound of a safe array.

HRESULT SafeArrayRedim(  
  SAFEARRAY *psa,              
  SAFEARRAYBOUND *psaboundNew  
);
psa

Pointer to an array descriptor.

psaboundNew

Pointer to a new safe array bound structure that contains the new array boundary. You can change only the least significant dimension of an array.

The return value obtained from the returned HRESULT is one of the following.

Value

Meaning

S_OK

Success.

DISP_E_ARRAYISLOCKED

The array is currently locked.

E_INVALIDARG

The item pointed to by psa is not a safe array descriptor.

If you reduce the bound of an array, SafeArrayRedim deallocates the array elements outside the new array boundary. If the bound of an array is increased, SafeArrayRedim allocates and initializes the new array elements. The data is preserved for elements that exist in both the old and new array.

Show:
© 2014 Microsoft. All rights reserved.