XLL+ Class Library

CXlOStream::read_args_from_template

Serializes the arguments passed to an add-in function

[C++]
bool read_args_from_template(
   void* first_arg,
   const char* arg_template,
   int omit_args
);

Parameters

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.)

arg_template

The function's argument string, which represents the data types of each of its arguments. This string is stored with the function definition when the argument is registered.

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 uses the signature string to read sequentially through the arguments in the stack.

Requirements

Header: xlserialize.h

See Also

CXlOStream Class | CXlOStream Methods