Difference between revisions of "ISInterface:DataParse"

From Lavish Software Wiki
Jump to navigation Jump to search
Line 1: Line 1:
 +
==Syntax==
 +
*int DataParse(const char *ToParse, char *buf, int buflen)
 
== Purpose ==
 
== Purpose ==
 
Performs in-place processing of [[LavishScript:Data Sequences|LavishScript Data Sequences]]
 
Performs in-place processing of [[LavishScript:Data Sequences|LavishScript Data Sequences]]
Line 5: Line 7:
 
=== Parameters ===
 
=== Parameters ===
 
*char *ToParse
 
*char *ToParse
: Null-terminated string to process
+
:'''[in]''' Null-terminated string to process
 +
*char *buf
 +
:'''[out]''' Results of the data parsing
 +
*int buflen
 +
:'''[in]'''  Buffer length
 
=== Return Value ===
 
=== Return Value ===
*bool
+
*int
: This function currently always returns true, but would ideally return false if processing fails
+
:Returns the length of the data in buf or -1 if the buffer would have overflowed
  
 
== Examples ==
 
== Examples ==
Line 14: Line 20:
 
== See Also ==
 
== See Also ==
 
* [[ISXDK:ISInterface|ISInterface]]
 
* [[ISXDK:ISInterface|ISInterface]]
 
+
*[[LavishScript:Data Sequences
 
[[Category:ISXDK]]
 
[[Category:ISXDK]]
 
[[Category:ISInterface]]
 
[[Category:ISInterface]]

Revision as of 00:21, 2 September 2005

Syntax

  • int DataParse(const char *ToParse, char *buf, int buflen)

Purpose

Performs in-place processing of LavishScript Data Sequences

Usage

Parameters

  • char *ToParse
[in] Null-terminated string to process
  • char *buf
[out] Results of the data parsing
  • int buflen
[in] Buffer length

Return Value

  • int
Returns the length of the data in buf or -1 if the buffer would have overflowed

Examples

See Also