SetDataString

Description

SetDataString gives the data to the plugin.

Syntax

int SetDataString(const wchar_t* iwszParameterName, const unsigned int iunTableSize, const wchar_t** ipTable);

Parameters

Input

  • iwszParameterName: data name the "ipTable" contains. See the list of possible values below.
  • iunTableSize: Size of the table "ipTable".
  • ipTable: A table that contains the data.

Return

(int) : returns the identification number of the error if an error occurs or 0 if no error occurs.

Example

To get a full example of the API use, download the .Plugin

#define OPT_PLUGIN_NO_ERROR 0
#define OPT_PLUGIN_ERROR_INVALID_DATA		4
struct DataString
{
     unsigned int Size;
     wchar_t** Table;
};
std::map<std::wstring, DataString> gmDatas;
int SetDataString(const wchar_t* iwszParameterName, const unsigned int iunTableSize, const wchar_t** ipTable)
{
     if (iunTableSize != 0 && ipTable != NULL)
     {
DataString theData;
theData.Size = iunTableSize;
theData.Table = ipTable;
std::wstring parameterName(iwszParameterName);
gmDatas[parameterName] = theData;
     }
     else
     {
return OPT_PLUGIN_ERROR_INVALID_DATA;
     }
     return OPT_PLUGIN_NO_ERROR;
}

List of the possible value of "iwszParameterName"

Parameter name Unit Description Organization
Eyebox EyeBoxNameOfConfigurations Name of configurations entered in the "Eyebox" tab kCFG
Other OutputFolder Output folder path. kCFG
Configuration NameOfConfigurations Name of the configurations. kCFG