Difference between revisions of "ISInterface:GetProfileSetting"

From Lavish Software Wiki
Jump to navigation Jump to search
 
 
Line 1: Line 1:
 
===Syntax===
 
===Syntax===
 
+
*bool GetProfileSetting(char *Setting, char *buf, unsigned long buflen)
 
== Purpose ==
 
== Purpose ==
 
+
To obtain a profile setting
 
== Usage ==
 
== Usage ==
 
=== Parameters ===
 
=== Parameters ===
 
+
*char *Setting
 +
:'''[in]''' Name of the setting to obtain
 +
*char *buf
 +
:'''[out]''' Buffer to put the setting into
 +
*unsigned long buflen
 +
:'''[in]''' Length of the buffer
 
=== Return Value ===
 
=== Return Value ===
 
+
*bool
 +
:Returns true on success, false on failure
 
== Examples ==
 
== Examples ==
 
+
char profilesettingbuffer[1024];
 +
pISInterface->GetProfileSetting("Preload Parameters",profilesettingbuffer,sizeof(profilesettingbuffer));
  
 
== See Also ==
 
== See Also ==

Latest revision as of 02:26, 3 September 2005

Syntax

  • bool GetProfileSetting(char *Setting, char *buf, unsigned long buflen)

Purpose

To obtain a profile setting

Usage

Parameters

  • char *Setting
[in] Name of the setting to obtain
  • char *buf
[out] Buffer to put the setting into
  • unsigned long buflen
[in] Length of the buffer

Return Value

  • bool
Returns true on success, false on failure

Examples

char profilesettingbuffer[1024];
pISInterface->GetProfileSetting("Preload Parameters",profilesettingbuffer,sizeof(profilesettingbuffer));

See Also