INSTR - Revision history

Admin: Created page with "= Action = Returns the position of a sub string in a string.
2013-02-11T19:31:44Z

Created page with "= <span class="f_Header">Action</span> = Returns the position of a sub string in a string. <span style="font-family: Arial;"> </span> <span style="font-family: Arial;"..."

New page
= <span class="f_Header">Action</span> =

Returns the position of a sub string in a string.

<span style="font-family: Arial;"> </span>

<span style="font-family: Arial;"> </span>

= <span class="f_Header">Syntax</span> =

var = <span class="f_Syntax">INSTR</span>( start , string , substr )

var = <span class="f_Syntax">INSTR</span>( string , substr )

<span style="font-family: Arial;"> </span>

<span style="font-family: Arial;"> </span>

= <span class="f_Header">Remarks</span> =
<div style="padding: 0px; margin: 0px 0px 0px 4px;">
{| width="549" cellspacing="0" cellpadding="1" border="1" style="border: 2px solid rgb(0, 0, 0); border-spacing: 0px; border-collapse: collapse;"
|- style="vertical-align: top;"
| valign="top" width="15%" style="width: 79px; border: 1px solid rgb(0, 0, 0);" |
Var

| valign="top" width="100%" style="width: 461px; border: 1px solid rgb(0, 0, 0);" |
Numeric variable that will be assigned with the position of the sub string in the string. Returns 0 when the sub string is not found.

When used with $BIGSTRINGS, the target variable should be a word instead of a byte.

|- style="vertical-align: top;"
| valign="top" width="15%" style="width: 79px; border: 1px solid rgb(0, 0, 0);" |
Start

| valign="top" width="100%" style="width: 461px; border: 1px solid rgb(0, 0, 0);" |
An optional numeric parameter that can be assigned with the first position where must be searched in the string. By default (when not used) the whole string is searched starting from position 1.

|- style="vertical-align: top;"
| valign="top" width="15%" style="width: 79px; border: 1px solid rgb(0, 0, 0);" |
String

| valign="top" width="100%" style="width: 461px; border: 1px solid rgb(0, 0, 0);" |
The string to search.

|- style="vertical-align: top;"
| valign="top" width="15%" style="width: 79px; border: 1px solid rgb(0, 0, 0);" |
Substr

| valign="top" width="100%" style="width: 461px; border: 1px solid rgb(0, 0, 0);" |
The search string.

|}
</div>
<span style="font-family: Arial;"> </span>

No constant can be used for <span style="font-style: italic;">string</span> it must be a string variable.

Only <span style="font-style: italic;">substr</span> can be either a string or a constant.

<span style="font-family: Arial;"> </span>

<span style="font-family: Arial;"> </span>

= <span class="f_Header">See also</span> =

[[SPLIT]] , [[CHARPOS]]

<span style="font-family: Arial;"> </span>

<span style="font-family: Arial;"> </span>

= <span class="f_Header">Example</span> =

<br/><source lang="bascomavr">
'-----------------------------------------------------------------------------------------
'name : instr.bas
'copyright : (c) 1995-2005, MCS Electronics
'purpose : INSTR function demo
'micro : Mega48
'suited for demo : yes
'commercial addon needed : no
'-----------------------------------------------------------------------------------------

$regfile = "m48def.dat" ' specify the used micro
$crystal = 4000000 ' used crystal frequency
$baud = 19200 ' use baud rate
$hwstack = 32 ' default use 32 for the hardware stack
$swstack = 10 ' default use 10 for the SW stack
$framesize = 40 ' default use 40 for the frame space

'dimension variables
Dim Pos As Byte
Dim S As String * 8 , Z As String * 8

'assign string to search
S = "abcdeab" ' Z = "ab"

'assign search string
Z = "ab"

'return first position in pos
Pos = Instr(s , Z)
'must return 1

'now start searching in the string at location 2
Pos = Instr(2 , S , Z)
'must return 6

Pos = Instr(s , "xx")
'xx is not in the string so return 0
End
</source><br/>{{Languages}}

[[Category:BASCOM Language Reference]]