VaKeR CYBER ARMY
Logo of a company Server : Apache/2.4.41 (Ubuntu)
System : Linux absol.cf 5.4.0-198-generic #218-Ubuntu SMP Fri Sep 27 20:18:53 UTC 2024 x86_64
User : www-data ( 33)
PHP Version : 7.4.33
Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare,
Directory :  /usr/share/doc/gnustep-base-doc/Base/Reference/

Upload File :
current_dir [ Writeable ] document_root [ Writeable ]

 

Current File : //usr/share/doc/gnustep-base-doc/Base/Reference/NSScanner.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">

    <head>
    <title>NSScanner class reference</title>
  </head>
  <body>
    <font face="serif">
    <a href="Base.html">Up</a>
    <br />
    <h1><a name="title$NSScanner">NSScanner class reference</a></h1>
    <h3>Authors</h3>
    <dl>
      <dt>Eric Norum (<a href="mailto:eric@skatter.usask.ca"><code>eric@skatter.usask.ca</code></a>)</dt>
      <dd>
      </dd>
      <dt>Richard Frith-Macdonald (<a href="mailto:rfm@gnu.org"><code>rfm@gnu.org</code></a>)</dt>
      <dd>
      </dd>
    </dl>
    <p><b>Copyright:</b> (C) 1996,1999 Free Software Foundation, Inc.</p>

        <div>
    </div>

          <h1><a name="001000000000">
        Software documentation for the NSScanner class
      </a></h1>
    <h2><a name="class$NSScanner">NSScanner</a> : <a rel="gsdoc" href="NSObject.html#class$NSObject">NSObject</a></h2>
    <blockquote class="declared">
      <dl>
        <dt><b>Declared in:</b></dt>
        <dd>Foundation/NSScanner.h</dd>
      </dl>
    </blockquote>
    <blockquote>
      <dl>
        <dt><b>Conforms to:</b></dt>
        <dd><a rel="gsdoc" href="NSObject.html#protocol$(NSCopying)">NSCopying</a></dd>
      </dl>
    </blockquote>
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
          
    </p>
    <p>

            The <code>NSScanner</code> class cluster (currently a
            single class in GNUstep) provides a mechanism to
            parse the contents of a string into number and string
            values by making a sequence of scan operations to
            step through the string retrieving successive items.
              </p>
    <p>
      
          
    </p>
    <p>

            You can tell the scanner whether its scanning is
            supposed to be case sensitive or not, and you can
            specify a set of characters to be skipped before
            each scanning operation (by default, whitespace and
            newlines).
              </p>
    <p>
      
        
    </div>
    <b>Method summary</b>
    <ul>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner+localizedScannerWithString$">+localizedScannerWithString:</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner+scannerWithString$">+scannerWithString:</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner-caseSensitive">-caseSensitive</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner-charactersToBeSkipped">-charactersToBeSkipped</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner-initWithString$">-initWithString:</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner-isAtEnd">-isAtEnd</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner-locale">-locale</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner-scanCharactersFromSet$intoString$">-scanCharactersFromSet:intoString:</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner-scanDecimal$">-scanDecimal:</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner-scanDouble$">-scanDouble:</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner-scanFloat$">-scanFloat:</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner-scanHexDouble$">-scanHexDouble:</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner-scanHexFloat$">-scanHexFloat:</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner-scanHexInt$">-scanHexInt:</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner-scanHexLongLong$">-scanHexLongLong:</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner-scanInt$">-scanInt:</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner-scanInteger$">-scanInteger:</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner-scanLocation">-scanLocation</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner-scanLongLong$">-scanLongLong:</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner-scanRadixUnsignedInt$">-scanRadixUnsignedInt:</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner-scanRadixUnsignedLongLong$">-scanRadixUnsignedLongLong:</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner-scanString$intoString$">-scanString:intoString:</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner-scanUpToCharactersFromSet$intoString$">-scanUpToCharactersFromSet:intoString:</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner-scanUpToString$intoString$">-scanUpToString:intoString:</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner-setCaseSensitive$">-setCaseSensitive:</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner-setCharactersToBeSkipped$">-setCharactersToBeSkipped:</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner-setLocale$">-setLocale:</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner-setScanLocation$">-setScanLocation:</a></li>
      <li><a rel="gsdoc" href="NSScanner.html#method$NSScanner-string">-string</a></li>
    </ul>
    <hr width="50%" align="left" />
<div class="method">
    <h3><a name="method$NSScanner+localizedScannerWithString$">localizedScannerWithString:&nbsp;</a></h3>
    + (id) <b>localizedScannerWithString:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aString;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            Returns an NSScanner instance set up to scan
            <var>aString</var> (using
            <a rel="gsdoc" href="#method$NSScanner-initWithString$">
              -initWithString:
            </a>

            and with a locale set the default locale (using
            <a rel="gsdoc" href="#method$NSScanner-setLocale$">
              -setLocale:
            </a>

          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner+scannerWithString$">scannerWithString:&nbsp;</a></h3>
    + (id) <b>scannerWithString:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aString;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            Create and return a scanner that scans
            <var>aString</var>. <br /> Uses
            <a rel="gsdoc" href="#method$NSScanner-initWithString$">
              -initWithString:
            </a>

            and with no locale set.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner-caseSensitive">caseSensitive&nbsp;</a></h3>
    - (BOOL) <b>caseSensitive</b>;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            If the scanner is set to be case-sensitive in its
            scanning of the string (other than characters to
            be skipped), this method returns <code>YES</code>,
            otherwise it returns <code>NO</code>. <br /> The
            default is for a scanner to <em>not</em> be case
            sensitive.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner-charactersToBeSkipped">charactersToBeSkipped&nbsp;</a></h3>
    - (<a rel="gsdoc" href="NSCharacterSet.html#class$NSCharacterSet">NSCharacterSet</a>*) <b>charactersToBeSkipped</b>;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            Returns a set of characters containing those
            characters that the scanner ignores when
            starting any scan operation. Once a character not
            in this set has been encountered during an operation,
            skipping is finished, and any further characters
            from this set that are found are scanned normally.
            <br /> The default for this is the
            whitespaceAndNewlineCharacterSet.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner-initWithString$">initWithString:&nbsp;</a></h3>
    - (id) <b>initWithString:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aString;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            Initialises the scanner to scan
            <var>aString</var>. The GNUstep implementation may
            make an internal copy of the original string - so it
            is not safe to assume that if you modify a mutable
            string that you initialised a scanner with, the
            changes will be visible to the scanner. <br />
            Returns the scanner object.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner-isAtEnd">isAtEnd&nbsp;</a></h3>
    - (BOOL) <b>isAtEnd</b>;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            Returns <code>YES</code> if no more characters
            remain to be scanned. <br /> Returns
            <code>YES</code> if all characters remaining to be
            scanned are to be skipped. <br /> Returns
            <code>NO</code> if there are characters left to
            scan.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner-locale">locale&nbsp;</a></h3>
    - (<a rel="gsdoc" href="NSDictionary.html#class$NSDictionary">NSDictionary</a>*) <b>locale</b>;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            Returns the locale set for the scanner, or
            <code>nil</code> if no locale has been set. A
            scanner uses it&apos;s locale to alter the way it
            handles scanning - it uses the NSDecimalSeparator
            value for scanning numbers.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner-scanCharactersFromSet$intoString$">scanCharactersFromSet:&nbsp;intoString:&nbsp;</a></h3>
    - (BOOL) <b>scanCharactersFromSet:</b> (<a rel="gsdoc" href="NSCharacterSet.html#class$NSCharacterSet">NSCharacterSet</a>*)aSet<b> intoString:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>**)value;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            After initial skipping (if any), this method scans
            any characters from <var>aSet</var>, terminating when a
            character not in the set is found. <br /> Returns
            <code>YES</code> if any character is scanned,
            <code>NO</code> otherwise. <br /> If
            <var>value</var> is not null, any character scanned
            are stored in a string returned in this location.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner-scanDecimal$">scanDecimal:&nbsp;</a></h3>
    - (BOOL) <b>scanDecimal:</b> (NSDecimal*)value;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
    <div class="desc">
      
            Not implemented.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner-scanDouble$">scanDouble:&nbsp;</a></h3>
    - (BOOL) <b>scanDouble:</b> (double*)value;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            After initial skipping (if any), this method scans a
            <strong>double</strong> <var>value</var>, placing
            it in <em>doubleValue</em> if that is not null. Returns
            <code>YES</code> if anything is scanned,
            <code>NO</code> otherwise. <br /> On overflow,
            HUGE_VAL or - HUGE_VAL is put into
            <em>doubleValue</em> <br /> On underflow, 0.0 is put
            into <em>doubleValue</em> <br /> Scans past any excess
            digits
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner-scanFloat$">scanFloat:&nbsp;</a></h3>
    - (BOOL) <b>scanFloat:</b> (float*)value;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            After initial skipping (if any), this method scans a
            <strong>float</strong> <var>value</var>, placing
            it in <em>floatValue</em> if that is not null. Returns
            <code>YES</code> if anything is scanned,
            <code>NO</code> otherwise. <br /> On overflow,
            HUGE_VAL or - HUGE_VAL is put into
            <em>floatValue</em> <br /> On underflow, 0.0 is put
            into <em>floatValue</em> <br /> Scans past any excess
            digits
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner-scanHexDouble$">scanHexDouble:&nbsp;</a></h3>
    - (BOOL) <b>scanHexDouble:</b> (double*)result;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.5.0</div>
<br />
    <div class="desc">
      
            Not implemented
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner-scanHexFloat$">scanHexFloat:&nbsp;</a></h3>
    - (BOOL) <b>scanHexFloat:</b> (float*)result;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.5.0</div>
<br />
    <div class="desc">
      
            Not implemented
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner-scanHexInt$">scanHexInt:&nbsp;</a></h3>
    - (BOOL) <b>scanHexInt:</b> (unsigned int*)value;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            After initial skipping (if any), this method scans a
            hexadecimal integer <var>value</var>
            (optionally prefixed by &quot;0x&quot; or &quot;0X&quot;), placing
            it in <em>intValue</em> if that is not null. <br />
            Returns <code>YES</code> if anything is scanned,
            <code>NO</code> otherwise. <br /> On overflow,
            INT_MAX or INT_MIN is put into <em>intValue</em>
            <br /> Scans past any excess digits
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner-scanHexLongLong$">scanHexLongLong:&nbsp;</a></h3>
    - (BOOL) <b>scanHexLongLong:</b> (unsigned long long*)value;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.5.0</div>
<br />
    <div class="desc">
      
            After initial skipping (if any), this method scans a
            hexadecimal <strong>long</strong>
            <strong>long</strong> <var>value</var> (optionally
            prefixed by &quot;0x&quot; or &quot;0X&quot;), placing it in
            <em>longLongValue</em> if that is not null. <br />
            Returns <code>YES</code> if anything is scanned,
            <code>NO</code> otherwise. <br /> On overflow,
            ULLONG_MAX or ULLONG_MAX is put into
            <em>longLongValue</em> <br /> Scans past any excess
            digits
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner-scanInt$">scanInt:&nbsp;</a></h3>
    - (BOOL) <b>scanInt:</b> (int*)value;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            After initial skipping (if any), this method scans a
            integer <var>value</var>, placing it in
            <em>intValue</em> if that is not null. <br /> Returns
            <code>YES</code> if anything is scanned,
            <code>NO</code> otherwise. <br /> On overflow,
            INT_MAX or INT_MIN is put into <em>intValue</em>
            <br /> Scans past any excess digits
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner-scanInteger$">scanInteger:&nbsp;</a></h3>
    - (BOOL) <b>scanInteger:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>*)value;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.5.0</div>
<br />
    <div class="desc">
      
            Not implemented
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner-scanLocation">scanLocation&nbsp;</a></h3>
    - (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>) <b>scanLocation</b>;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            Returns the current position that the scanner has
            reached in scanning the string. This is the
            position at which the next scan operation will
            begin.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner-scanLongLong$">scanLongLong:&nbsp;</a></h3>
    - (BOOL) <b>scanLongLong:</b> (long long*)value;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            After initial skipping (if any), this method scans a
            <strong>long</strong> decimal integer
            <var>value</var> placing it in <em>longLongValue</em>
            if that is not null. <br /> Returns <code>YES</code> if
            anything is scanned, <code>NO</code> otherwise.
            <br /> On overflow, LLONG_MAX or LLONG_MIN is put
            into <em>longLongValue</em> <br /> Scans past any
            excess digits
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner-scanRadixUnsignedInt$">scanRadixUnsignedInt:&nbsp;</a></h3>
    - (BOOL) <b>scanRadixUnsignedInt:</b> (unsigned int*)value;<br />
    <div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
    <div class="desc">
      
            After initial skipping (if any), this method scans an
            <strong>unsigned</strong> integer placing it in
            <em><var>value</var></em> if that is not null. If the
            number begins with &quot;0x&quot; or &quot;0X&quot; it is treated as
            hexadecimal, otherwise if the number begins
            with &quot;0&quot; it is treated as octal, otherwise the number
            is treated as decimal. <br /> Returns <code>YES</code>
            if anything is scanned, <code>NO</code> otherwise.
            <br /> On overflow, UINT_MAX is put into
            <em><var>value</var></em> <br /> Scans past any excess
            digits
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner-scanRadixUnsignedLongLong$">scanRadixUnsignedLongLong:&nbsp;</a></h3>
    - (BOOL) <b>scanRadixUnsignedLongLong:</b> (unsigned long long*)value;<br />
    <div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
    <div class="desc">
      
            After initial skipping (if any), this method scans an
            <strong>unsigned</strong> <strong>long</strong>
            <strong>long</strong> integer placing it in
            <em><var>value</var></em> if that is not null. If the
            number begins with &quot;0x&quot; or &quot;0X&quot; it is treated as
            hexadecimal, otherwise if the number begins
            with &quot;0&quot; it is treated as octal, otherwise the number
            is treated as decimal. <br /> Returns <code>YES</code>
            if anything is scanned, <code>NO</code> otherwise.
            <br /> On overflow, ULLONG_MAX is put into
            <em><var>value</var></em> <br /> Scans past any excess
            digits
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner-scanString$intoString$">scanString:&nbsp;intoString:&nbsp;</a></h3>
    - (BOOL) <b>scanString:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)string<b> intoString:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>**)value;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            After initial skipping (if any), this method scans
            for <var>string</var> and places the characters found
            in <var>value</var> if that is not null. <br /> Returns
            <code>YES</code> if anything is scanned,
            <code>NO</code> otherwise.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner-scanUpToCharactersFromSet$intoString$">scanUpToCharactersFromSet:&nbsp;intoString:&nbsp;</a></h3>
    - (BOOL) <b>scanUpToCharactersFromSet:</b> (<a rel="gsdoc" href="NSCharacterSet.html#class$NSCharacterSet">NSCharacterSet</a>*)aSet<b> intoString:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>**)value;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            After initial skipping (if any), this method scans
            characters until it finds one in <em>set</em>.
            The scanned characters are placed in
            <em>stringValue</em> if that is not null. <br />
            Returns <code>YES</code> if anything is scanned,
            <code>NO</code> otherwise.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner-scanUpToString$intoString$">scanUpToString:&nbsp;intoString:&nbsp;</a></h3>
    - (BOOL) <b>scanUpToString:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)string<b> intoString:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>**)value;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            
    </p>
    <p>

              After initial skipping (if any), this method scans
              characters until it finds <var>string</var>.
              The scanned characters are placed in <var>value</var>
              if that is not null. If <var>string</var> is not
              found, all the characters up to the end of the
              scanned <var>string</var> will be returned.
                </p>
    <p>
      
            Returns <code>YES</code> if anything is scanned,
            <code>NO</code> otherwise. <br />
            
    </p>
    <p>

              NB. If the current scanner location points to a copy
              of <var>string</var>, or points to skippable
              characters immediately before a copy of
              <var>string</var> then this method returns
              <code>NO</code> since it finds no characters to
              store in <var>value</var> before it finds
              <var>string</var>.
                </p>
    <p>
      
            
    </p>
    <p>

              To count the occurrences of <var>string</var>, this
              should be used in conjunction with the
              <a rel="gsdoc" href="#method$NSScanner-scanString$intoString$">
                -scanString:intoString:
              </a>

              method.
                </p>
    <p>
      

<pre>
 NSString *ch = @&quot;[&quot;;
 unsigned total = 0;

 [scanner scanUpToString: ch intoString: NULL];
 while ([scanner scanString: ch intoString: NULL] == YES)
  {
    total++;
    [scanner scanUpToString: ch intoString: NULL];
  }
 NSLog(@&quot;total %d&quot;, total);
 </pre>
      
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner-setCaseSensitive$">setCaseSensitive:&nbsp;</a></h3>
    - (void) <b>setCaseSensitive:</b> (BOOL)flag;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            Sets the case sensitivity of the scanner. <br /> Case
            sensitivity governs matching of characters
            being scanned, but does not effect the characters in
            the set to be skipped. <br /> The default is for a
            scanner to <em>not</em> be case sensitive.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner-setCharactersToBeSkipped$">setCharactersToBeSkipped:&nbsp;</a></h3>
    - (void) <b>setCharactersToBeSkipped:</b> (<a rel="gsdoc" href="NSCharacterSet.html#class$NSCharacterSet">NSCharacterSet</a>*)aSet;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            Sets the set of characters that the scanner will skip
            over at the start of each scanning operation to be
            <em>skipSet</em>. Skipping is performed by literal
            character matching - the case sensitivity of the
            scanner does not effect it. If this is set to
            <code>nil</code>, no skipping is done. <br /> The
            default for this is the
            whitespaceAndNewlineCharacterSet.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner-setLocale$">setLocale:&nbsp;</a></h3>
    - (void) <b>setLocale:</b> (<a rel="gsdoc" href="NSDictionary.html#class$NSDictionary">NSDictionary</a>*)localeDictionary;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            This method sets the locale used by the scanner to
            <em>aLocale</em>. The locale may be set to
            <code>nil</code>.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner-setScanLocation$">setScanLocation:&nbsp;</a></h3>
    - (void) <b>setScanLocation:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)anIndex;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            This method sets the location in the scanned string at
            which the next scan operation begins. Raises an
            NSRangeException if index is beyond the
            end of the scanned string.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSScanner-string">string&nbsp;</a></h3>
    - (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*) <b>string</b>;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            Returns the string being scanned.
          
    </div>
    <hr width="25%" align="left" />
</div>
    <br />
    <a href="Base.html">Up</a>
    </font>
</body>
</html>

VaKeR 2022