Basic:DriverObject:Function:Set_Parameter

Set_Parameter

Header:

extern SFENCEAPI enum eSFENCE_Bool SFENCECALL Object_Object_Set_Parameter(struct sObject_Object *ps_object, idSFENCE_Parameter id_parameter, const char *t_name, struct sVariable_Type *ps_value);

Parameters:

Parameter	Meaning
ps_object	pointer of Object_Object
id_parameter	identification number of parameter. Can be 0 if t_name parameter isn't NULL.
t_name	name (NULL terminated string) of parameter. Can be NULL if id_parameter parameter isn't 0.
ps_value	new value of parameter stored in object Variable_Type

Return value:

Value	Meaning
eSFENCE_Bool_True, eSFENCE_Bool_Success	parameter was successfully set
eSFENCE_Bool_False	unknown parameter
eSFENCE_Bool_Fail	setting parameter failed

Description:

Set_Parameter function is used for set a parameter of object. The parameter is specified by id or name or both of them. New parameter of value is stored in object Variable_Type.

Example:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25

enum eSFENCE_Bool Example_SetParameter(struct sUniversal_Universal *ps_universal) { Mac_Var_Variable_Type_Declaration(value) if (Variable_Type_Construct(ps_value, ps_pack)==NULL) return eSFENCE_Bool_Fail; while (1) { // store value to ps_value if (Variable_Type_FromText(ps_value, "text", FLAG_VARIABLE_TYPE_COPY) !=eSFENCE_Bool_Success) break; // set object parameter if (Universal_Universal_Set_Parameter(ps_universal, 1, "name", ps_value) !=eSFENCE_Bool_Success) break; Variale_Type_Destruct(ps_value, eSFENCE_Bool_False); return eSFENCE_Bool_Success; } Variale_Type_Destruct(ps_value, eSFENCE_Bool_False); return eSFENCE_Bool_Fail; }