Phantom Documentation

[Help Home] [Phantom Home]
AddOption

int options.AddOption(string,string)

Return Type: int
Parameters: string sKey, string sValue

Description:

This function adds a new key/value pair to the options set. The new key will be sKey and its associated value sValue. The key/value pair will be separated by the string token set in the SetToken function. The value can later be retrieved by using GetOption with the sKey as the parameter. The options data type can not have multiple keys with the same name. If sKey already exists, the option will not be added and a 0 will be returned.

The return value is 1 if the option was successfully added, 0 otherwise.

For an example, see options.

See Also: options, GetOption


Copyright 2000-2011 Phantom Automated Solutions