Core Function NthField - Revision history

UberFoX: 1 revision

2015-06-14T12:37:25Z

1 revision

← Older revision

Revision as of 12:37, 14 June 2015

UberFoX: 1 revision

2014-08-11T21:41:00Z

1 revision

← Older revision

Revision as of 21:41, 11 August 2014

UberFoX: /* trimtype */

2013-08-23T18:43:05Z

trimtype

← Older revision		Revision as of 18:43, 23 August 2013
Line 48:		Line 48:

	0 = Trim Unquoted Only (Default)		0 = Trim Unquoted Only (Default)
		+
	1 = Trim Quoted Only		1 = Trim Quoted Only
		+
	2 = Trim All		2 = Trim All
		+
	3 = Trim None		3 = Trim None

UberFoX: /* Description */

2013-08-23T17:58:50Z

Description

← Older revision		Revision as of 17:58, 23 August 2013
Line 7:		Line 7:
	Returns a field from a row of data (such as comma separated text).		Returns a field from a row of data (such as comma separated text).

−	This function is useful for reading columns of data from a text file where the columns (fields) are delimited with a specific character or characters and a specific one at a given index	+	This function is useful for reading columns of data from a text file where the columns (fields) are delimited with a specific character or characters and returning a specific one from a given index.

	=== Parameters ===		=== Parameters ===

UberFoX: /* Return Value */

2013-08-23T17:58:18Z

Return Value

← Older revision		Revision as of 17:58, 23 August 2013
Line 56:		Line 56:
	=== Return Value ===		=== Return Value ===

−	Success: Returns ~~number of how many values~~ (~~fields~~) ~~there are~~.	+	Success: Returns all text from the field at the given location (index).

−	Failure: Returns 0.	+	Failure: Returns empty string.

	=== Remarks ===		=== Remarks ===

UberFoX: Created page with "

 NthField( , , , , , ,  )

=== Description === Returns a field from a row of data (such as comma separat..."

2013-08-23T17:57:26Z

Created page with "<pre> NthField( <string>, <delim>, <index>, <quote>, <quoteescape>, <comment>, <trimtype> ) </pre> === Description === Returns a field from a row of data (such as comma separat..."

New page

<pre>
NthField( <string>, <delim>, <index>, <quote>, <quoteescape>, <comment>, <trimtype> )
</pre>

=== Description ===

Returns a field from a row of data (such as comma separated text).

This function is useful for reading columns of data from a text file where the columns (fields) are delimited with a specific character or characters and a specific one at a given index

=== Parameters ===

==== string ====

The string to parse.

==== delim ====

The Char to use as the Delimiter for seperation of the data.

==== index ====

The column number of the desired field. The first field is numbered 0.

==== quote ====

Optional; The Char to use as the Quote this will be allowed to contain the Delimiter inside it.

Default is '"'

==== quoteescape ====

Optional; The Char to use for escaping the Quote this will be used to allow a Quote to appear inside quotes.

Default is "\\"

==== comment ====

Optional; The Char to use as the Comment and it will be removed from the text with no side effects.

Default is '#'

Can be set to "\0" to disable need for comment

==== trimtype ====

Optional; Determines how values should be trimmed.

0 = Trim Unquoted Only (Default)
1 = Trim Quoted Only
2 = Trim All
3 = Trim None

Default is: 0

=== Return Value ===

Success: Returns number of how many values (fields) there are.

Failure: Returns 0.

=== Remarks ===

This function uses [[Core Function CSV|CSV()]] for it's parsing needs.

If you wish to return all the fields in arrays instead of just returning a specific field at a specific index then you must use [[Core Function CSV|CSV()]] instead.

=== Example ===

The following example prints each Month one by one using the NthField function.
<syntaxhighlight lang="sputnik">
$s = "January,February,March,April,May,June,July,August,September,October,November,December";
$last = CountFields($s,",");
For( $i = 0; $i <= $last; $i++)
println(NthField($s,",",$i));
</syntaxhighlight>

This example returns "Smith"
<syntaxhighlight lang="sputnik">
$field = NthField("Dan*Smith*11/22/69*5125554323*Male","*",1);
println($field);
</syntaxhighlight>

This example demonstrates the use of a multiple character separator.
<syntaxhighlight lang="sputnik">
$days = "Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday";
$Wed = NthField($days, ", ", 2); //sets Wed to "Wednesday"
println($Wed);
</syntaxhighlight>

[[Category:Core Function]]