Difference between revisions of "ISInterface:GetSetting"

From Lavish Software Wiki
Jump to navigation Jump to search
 
Line 34: Line 34:
 
== Examples ==
 
== Examples ==
 
  char settingbuffer[1024];
 
  char settingbuffer[1024];
  pISInterface->(parentsetguid,"favorite food",settingbuffer,sizeof(settingbuffer));
+
  pISInterface->GetSetting(parentsetguid,"favorite food",settingbuffer,sizeof(settingbuffer));
 
   
 
   
 
== See Also ==
 
== See Also ==

Latest revision as of 01:24, 8 September 2005

Syntax

  • bool GetSetting(unsigned long &SetGUID, char *Setting, char *buf, unsigned long buflen)
  • bool GetSetting(unsigned long &SetGUID, char *Setting, bool &bValue)
  • bool GetSetting(unsigned long &SetGUID, char *Setting, int &iValue)
  • bool GetSetting(unsigned long &SetGUID, char *Setting, float &fValue)
  • bool GetSetting(unsigned long &SetGUID, char *Setting, unsigned long &ulValue)
  • bool GetSetting(unsigned long &SetGUID, char *Setting, __int64 &Value)

Purpose

To get the value of a specific setting in a set

Usage

Parameters

  • unsigned long &SetGUID
[in] unique identifier of the set to get the setting from
  • char *Setting
[in] Name of the setting
  • char *buf
[out] Buffer to hold the value of a setting
  • unsigned long buflen
[in] Length of the buffer
  • bool &bValue
[out] boolean variable to hold the value of a setting
  • int &iValue
[out] integer variable to hold the value of a setting
  • float &fValue
[out] float variable to hold the value of a setting
  • unsigned long &ulValue
[out] unsigned long variable to hold the value of a setting
  • __int64 &Value
[out] 64-bit integer variable to hold the value of a setting

Return Value

  • bool
Returns true on success, false on failure

Examples

char settingbuffer[1024];
pISInterface->GetSetting(parentsetguid,"favorite food",settingbuffer,sizeof(settingbuffer));

See Also