Sets a property where input name and value are both strings.
Syntax
GsFunStat GsPropSetAsStr(PropList* pProps,
gs_const_str pszPropName, PropEnum propID,
gs_const_str pszValue);
Arguments
PropList*pProps Pointer to property list structure. Input and Output.
gs_const_str pszPropName The string name of the property to set. Input.
PropEnumpropID Property ID. Input.
gs_const_strpszValue The string value of the property. Input.
Return Values
GS_ERROR
GS_SUCCESS
Prerequisites
GsPropListCreate()
Notes
This function performs the conversion to correct property enum ID and property value type. If the input property name is a NULL pointer, the property ID is for use in identifying the property instead. If both property name and property ID are present, preference is given to the property name, ignoring the property ID.
Example
GsFunStat retval;
PropList initProps;
retval = GsPropListCreate(&initProps, GS_INIT_PROP_LIST_TYPE);
retval = GsPropSetAsStr(&initProps, "GS_INIT_PASSWORD", GS_UNDEFINED_PROPID, "12345678");
retval = GsPropSetAsStr(&initProps, NULL, GS_INIT_PASSWORD, "12345678");