Tokenizer_KeySetUserString

<< Click to Display Table of Contents >>

Navigation:  ThinBASIC Modules > Tokenizer >

Tokenizer_KeySetUserString

 

Description

 

Set a string user data associated with a Tokenizer user key giving key pointer

 

Syntax

 

nIndex = Tokenizer_KeySetUserString(pKey, sData, [Index])

 

Returns

 

Number

The index set

 

Parameters

 

Name

Type

Optional

Meaning

pKey

Number

No

A pointer to user key.

sData

String

No

The string user data to set

Index

Number

Yes

Up to 10 user string can be associated with any key. If Index is not present 1 will be assumed.

 

Remarks

 

Restrictions

 

See also

 

Examples