Represents a single add-in function.
class CXllFn |
The CXllFn object represents a function that can be (and may already have been) registered. The class is used extensively by the framework, but is only of use to you as an add-in author if you wish to inspect or modify function definitions at run-time.
The public data members if CXllFn are listed below. Many of the values used by Excel 2007 are wide strings. See Wide strings for help on how to use these.
| CStringW | m_stName | Name of function in Excel. (Note that this field is now a wide string, whereas it was a standard string under XLL+ 5 and below. See Breaking changes for more details.) |
| CStringA | m_stEntryPoint4 | Name of C wrapper function used under earlier versions of Excel. |
| CStringA | m_stEntryPoint12 | Name of C wrapper function used under Excel 2007 and above. |
| CStringA | m_stArgTemplate4 | Argument template for earlier versions of Excel, containing the return type, the data types of the arguments and behaviour flags. |
| CStringW | m_stArgTemplate12 | Argument template for Excel 2007, containing the return type, the data types of the arguments and behaviour flags. |
| CStringA | m_stArgNames4 | Argument names for earlier versions of Excel, separated by commas. |
| CStringW | m_stArgNames12 | Argument names for Excel 2007 and above, separated by commas. |
| USHORT | m_usType | Availability flag. 1 indicates that the function can be called from worksheets; 2 that it can be called from macro sheets; 0 that it can be called from either, but is not shown in the Excel Formula Wizard. No other value is acceptable. |
| CStringA | m_stCategory4 | The category under which the function will appear in the Excel Function Wizard, under earlier versions of Excel. |
| CStringW | m_stCategory12 | The category under which the function will appear in the Excel Function Wizard, under Excel 2007 and above. |
| USHORT | m_usHelpTopic | The help topic ID for the function. 0 indicates that no help is available. |
| CStringW | m_stHelpTopic | The help topic identifier string for the function. If this is empty, then the help topic ID will be used. |
| CStringA | m_stHelpText4 | Description of function (as displayed by Excel Function Wizard), under earlier versions of Excel. |
| CStringW | m_stHelpText12 | Description of function (as displayed by Excel Function Wizard), under Excel 2007 and above. |
| CStringA[] | m_astArgHelpText4 | String array containing descriptions of each argument (as displayed by Excel Function Wizard), under earlier versions of Excel. |
| CStringW[] | m_astArgHelpText12 | String array containing descriptions of each argument (as displayed by Excel Function Wizard), under Excel 2007 and above. |
| CString | m_stKey | Fast key to invoke macro function. |
Header: xllplus.h