String() [1/4]

drama::gitarg::String::String ( const sds::Id &  Id, const std::string &  Name = "Argument1", const int  Position = 1, const std::string &  Default = "", const Flags  flags = Flags::KeepErr  )

inline

Constructor with the initial value set from an SDS structure.

The value is fetched from the named item (arg #2) within the SDS structure specified. or the Position (constructor arg #3) item in the
structure if the item named does not exist.

Note

The DRAMA lock must be taken when executing this. If in a thread, the preference is to take it by constructing a drama::AccessDrama object to ensure the action context is correct. An alternative overload of this method will take the lock itself.

Parameters

Id	The SDS structure.
Name	The name of the item within the structure.
Position	If the item does not exist by the name, then presume this position.
Default	The default value. If not specified, an empty string is used.
flags	Which GIT Flags to apply. If you specify KeepErr, then an exception is thrown if the value in the SDS structure is invalid. If you don't specify KeepErr and and the SDS structure does not contain a value item, then the value is set to the supplied default.

References drama::CreateRunDramaTask(), drama::Default, and Get().