<doc>
	<legacy_id></legacy_id>
	<name>codeunitOffset</name>
	<type>function</type>

	<syntax>
		<example>codeunitOffset(stringToFind,stringToSearch[,codeunitsToSkip])</example>
		<example></example>
		<example></example>
		<example></example>
		<example></example>
	</syntax>

	<synonyms>
	</synonyms>

	<summary>Returns the number of codeunits between the beginning of a value and an occurrence of a specified string.</summary>

	<examples>
<example><p>condeunitOffset(tCodeUnit, "This is the string to search")</p></example>
<example><p></p></example>
<example><p></p></example>
<example><p></p></example>
<example><p></p></example>
	</examples>

	<history>
		<introduced version="7.0">Added.</introduced>
		<deprecated version=""></deprecated>
		<removed version=""></removed>
		
		<experimental version=""></experimental>
		<nonexperimental version=""></nonexperimental>
	</history>

	<objects>
	</objects>

	<platforms>
		<mac/>
		<windows/>
		<linux/>
		<ios/>
		<android/>
	</platforms>

	<classes>
		<desktop/>
		<server/>
		<web/>
		<mobile/>
	</classes>

	<security>
	</security>


	<classification>
		<category>Text and Data Processing</category>
		<category></category>
		<category></category>
		<category></category>
		<category></category>
	</classification>

	<references>
		<function tag="wordOffset">wordOffset function</function>
		<function tag="offset">offset function</function>
		<function tag="paragraphOffset">paragraphOffset function</function>
		<function tag="truewordOffset">truewordOffset function</function>
		<function tag="tokenOffset">tokenOffset function</function>
		<function tag="codepointOffset">codepointOffset function</function>
		<function tag="sentenceOffset">sentenceOffset function</function>
		<function tag="byteOffset">byteOffset function</function>
		<property tag="wholeMatches">wholeMatches property</property>
		<keyword tag="codeunit">codeunit keyword</keyword>
	</references>

	<description>
	<overview>Use the <b>codeunitOffset</b> function to find which sentence a string occurs in.</overview>

		<parameters>
  <parameter>
    <name>stringToFind</name>
    <description>The stringToFind is a string or an expression that evaluates to a string.</description>
  </parameter>
  <parameter>
    <name>stringToSearch</name>
    <description>The stringToSearch is a string or an expression that evaluates to a string.</description>
  </parameter>
  <parameter>
    <name>codeunitsToSkip</name>
    <description>The codeunitsToSkip is a non-negative integer. If you don't specify how many codeunitsToSkip, the codeunitOffset function does not skip any codeunits.</description>
  </parameter>		</parameters>

	<value>The <b>codeunitOffset</b> function returns a non-negative integer.</value>
	<comments><p>The value returned by the <b>codeunitOffset</b> function is the number of the codeunit where the <i>stringToFind</i> appears in <i>stringToSearch</i>. If the <i>stringToFind</i> is not in <i>stringToSearch</i>, the <b>codeunitOffset</b> function returns zero. If the <i>stringToFind</i> is more than one codeunit, the <b>codeunitOffset</b> function always returns zero, even if the <i>stringToFind</i> appears in the <i>stringToSearch</i>.</p><p></p><p>If you specify how <i>manycodeunitsToSkip</i>, the <b>codeunitOffset</b> function skips the specified number of sentences in the <i>stringToSearch</i>. The value returned is relative to this starting point instead of the beginning of the <i>stringToSearch</i>.</p></comments>
	</description>
</doc>
