XLL+ Class Library (6.3)

CXlWizExUIArgumentListCreator::CXlWizExUIArgumentListCreator

Constructs a CXlWizExUIArgumentListCreator object

CXlWizExUIArgumentListCreator(
   const TCHAR* pszName,
   int argIndex,
   const std::vector<CString>& vlist
);
CXlWizExUIArgumentListCreator(
   const TCHAR* pszName,
   int argIndex,
   const TCHAR** list,
   int nPairs = -1
);
CXlWizExUIArgumentListCreator(
   const TCHAR* pszName,
   int argIndex,
   const TCHAR* text,
   TCHAR chFieldSep = ',',
   TCHAR chLineSep = ';'
);

Parameters

pszName

The exported name of the function.

argIndex

The index of the argument. (The first argument has index 0.)

vlist

A set of alternating value/description pairs, in the order value1, description1, value2, description2, etc.

These pairs will be added to the new object.

list

An array of pointers to strings. The array should contain a set of alternating value/description pairs, in the order value1, description1, value2, description2, etc.

If nPairs is negative, then a NULL pointer should end the list.

If nPairs is positive, then list should contain nPairs * 2 strings.

These pairs will be added to the new object.

nPairs

The number of pairs of values in the list.

If nPairs is negative, then a NULL pointer should end the list.

If nPairs is positive, then list should contain nPairs * 2 strings.

text

A single null-terminated string containing a set of alternating value/description pairs, in the order value1, description1, value2, description2, etc.

Each value and description should be separated by the character specified as chFieldSep. Each pair should be separated by the character specified as chLineSep.

For example, if chFieldSep is a comma, and chLineSep is a semicolon, then a suitable text string might be: "value1,description of value1;value2,description of value2"

The pairs parsed from text will be added to the new object.

chFieldSep

The character used to separate a value from its description.

chLineSep

The character used to separate a value/description pair from the next pair.

Requirements

Header: xlwizexui.h

See Also

CXlWizExUIArgumentListCreator Class | CXlWizExUIArgumentListCreator Methods