IDL_RPCMakeArray

char * IDL_RPCMakeArray( int type,  int n_dim, IDL_MEMINT dim[],  
    int init, IDL_VPTR *var)

Description

This function creates an IDL RPC client temporary array variable with a data area of the specified size.

Parameters

type

The IDL type code for the resulting array. IDL type codes are discussed in Type Codes.

n_dim

The number of array dimensions. The constant IDL_MAX_ARRAY_DIM defines the upper limit of this value.

dim

A C array of IDL_MAX_ARRAY_DIM elements containing the array dimensions. The number of dimensions in the array is given by the n_dim argument.

init

This parameter specifies the sort of initialization that should be applied to the resulting array. init must be one of the following:

IDL_ARR_INI_NOP — No initialization is done. The data area of the array will contain whatever garbage was left behind from its previous use.

IDL_ARR_INI_ZERO — The data area of the array is zeroed.

var

The address of an IDL_VPTR containing the address of the resulting IDL RPC client temporary variable.

Return Value

On success, this function returns a pointer to the data area of the allocated array. The value returned is the same as is contained in the var->value.arr->data field of the variable. On failure, it returns NULL.

As with variables returned from IDL_RPCGettmp(), the variable allocated via this function must be de-allocated using IDL_RPCDeltmp() when the variable is no longer needed.

IDL Online Help (March 06, 2007)