CXlOStream::read_args

Serializes the arguments passed to an add-in function

bool read_args(
   const char* fn_name,
   void* first_arg,
   int omit_args
);

Parameters

fn_name

The name of the add-in function being called.

first_arg

A pointer to the first argument passed to the function. (Further arguments will follow the first, according to the standard argument-packing pattern for __stdcall functions.)

omit_args

The index of the first argument which should be omitted from the serialization. If omit_args is -1, then it is ignored, and all passed arguments are serialized.

Return Value

Remarks

This function serializes the arguments passed by Excel to an add-in function, optionally omitting some terminal arguments.

The function looks up the definition of the function as it was declared and registered, and acquires the list of argument types (the signature) of the function. It uses the signature string to read sequentially through the arguments in the stack.

Requirements

Header: xlserialize.h

See Also

CXlOStream Class | CXlOStream Methods