Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
virtual P6R::P6ERR P6R::p6ISafeString::strToBool ( const P6CHAR pBoolStr,
P6BOOL pBool 
)
pure virtual

Converts a boolean string representation to a P6R::P6BOOL.

For example, the string 'true', 'yes' and on will be converted to P6TRUE. Note that only the first character is tested and the comparison is case insensative. Valid boolean strings are:

  • yes / no
  • true / false
  • 1 / 0
Parameters
pBoolStr[ in ] A pointer to the NULL terminated string to convert.
pBool[ out ] The address of a P6R::P6BOOL in which will be placed the conversion value.
Returns
SuccessP6R::eOk 
FailureP6R::eInvalidArgpBoolStr or pBool is NULL
P6R::eFormatErrorpBoolStr did not contain a boolean string.*pBool is set to P6FALSE