External Development Guide: Remote Procedure Calls

Variable Accessor Macros

The following macros can be used to get information on IDL RPC variables. These macros are defined in idl_rpc.h.

All of these macros accept a single argument, v, of type IDL_VPTR.

IDL_RPCGetArrayData(v)

This macro returns a pointer (char*) to the data area of an array block.

IDL_RPCGetArrayDimensions(v)

This macro returns a C array which contains the array dimensions.

IDL_RPCGetArrayNumDims(v)

This macro returns the number of dimensions of the array.

IDL_RPCGetVarByte(v)

This macro returns the value of a 1-byte, unsigned char variable.

IDL_RPCGetVarComplex(v)

This macro returns the value (as a struct, not a pointer) of a complex variable.

IDL_RPCGetVarComplexR(v)

This macro returns the real field of a complex variable.

IDL_RPCGetVarComplexI(v)

This macro returns the imaginary field of a complex variable.

IDL_RPCGetVarDComplex(v)

This macro returns the value (as a struct, not a pointer) of a double precision, complex variable.

IDL_RPCGetVarDComplexR(v)

This macro returns the real field of a double-precision complex variable.

IDL_RPCGetVarDComplexI(v)

This macro returns the imaginary field of a double-precision complex variable.

IDL_RPCGetVarDouble(v)

This macro returns the value of a double-precision, floating-point variable.

IDL_RPCGetVarFloat(v)

This macro returns the value of a single-precision, floating-point variable.

IDL_RPCGetVarInt(v)

This macro returns the value of a 2-byte integer variable.

IDL_RPCGetVarLong(v)

This macro returns the value of a 4-byte integer variable.

IDL_RPCGetVarLong64(v)

This macro returns the value of a 8-byte integer variable.

IDL_RPCVarIsArray(v)

This macro returns non-zero if v is an array variable.

IDL_RPCGetVarString(v)

This macro returns the value of a string variable (as a char*).

IDL_RPCGetVarType(v)

This macro returns the type code of the variable. IDL type codes are discussed in Type Codes.

IDL_RPCGetVarUInt(v)

This macro returns the value of an unsigned 2-byte integer variable.

IDLRPCGetVarULong(v)

This macro returns the value of an unsigned 4-byte integer variable.

IDL_RPCGetVarULong64(v)

This macro returns the value of an unsigned 8-byte integer value.

  IDL Online Help (March 06, 2007)