This element defines a function extension. It must contain an Insertions child element. It may contain any or all of the following optional child elements, each of which may appear only once or not at all: LocalizedDisplayName, LocalizedDescription, Parameters. It must contain the required attribute name. It may contain the following optional attributes: headerFiles and ignoreLocalHeaders.
Required. The name attribute uniquely defines the name of the function extension. If two extensions use the same name, then the one that is loaded second will override the one that was loaded first. The name is not used in any C++ code, and does not need to be a valid C++ identifier. However, it is used as the persisted form of the extension's type, and therefore can never be changed.
The headerFiles attribute contains a list of the header files that are needed in order for the code inserted by this extension to compile correctly. The file name should not be surrounded by quotes or <...>. Multiple file names can be used, and should be separate by semi-colons, e.g. "myfile.h;..\inc\otherfile.h". Each file will be inserted as a local file if ignoreLocalHeaders is false, e.g. #include "myfile.h", and as a global file if ignoreLocalHeaders is true, e.g. #include <myfile.h>.
The ignoreLocalHeaders attribute controls whether the list of header files contained in the headerFiles attribute will be treated as local or global header files. Each file will be inserted as a local file if ignoreLocalHeaders is false, e.g. #include "myfile.h", and as a global file if ignoreLocalHeaders is true, e.g. #include <myfile.h>.
|
Number of occurrences |
Unlimited |
|
Parent elements |
|
|
Child elements |
Insertions LocalizedDisplayName LocalizedDescription Parameters |