IDL_RPCImportArray

Calling Sequence

IDL_VPTR IDL_RPCImportArray(int n_dim, IDL_MEMINT dim[], 
    int type, UCHAR *data, IDL_ARRAY_FREE_CB free_cb) 

Description

Use this function to create an IDL array variable whose data the server supplies, rather than having the client API allocate the data space.

Parameters

n_dim

The number of dimensions in the array.

dim

An array of IDL_MAX_ARRAY_DIM elements, containing the size of each dimension.

type

The IDL type code describing the data. IDL type codes are discussed in Type Codes.

data

A pointer to your array data.

free_cb

If non-NULL, free_cb is a pointer to a function that will be called when the IDL RPC client routines frees the array. This feature gives the caller a sure way to know when the data is no longer referenced. Use the called function to perform any required cleanup, such as freeing dynamic memory or releasing shared or mapped memory.

Return Value

An IDL_VPTR that points to an IDL_VARIABLE structure containing a reference to the imported array. This function returns NULL if the operation was unsuccessful.