docs/Categories/NSString(SDLEnum).html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

<h1>NSString(SDLEnum) Category Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section--isEqualToEnum:">-isEqualToEnum:</a></li>
</ul>

<h3>Overview</h3>

<p>Undocumented</p>


<section class="section task-group-section">
  <h3 id="section--isEqualToEnum:">
      -isEqualToEnum:
  </h3>
  
  <p>Returns whether or not two enums are equal.</p>

  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">isEqualToEnum</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type Definitions.html#/c:SDLEnum.h@T@SDLEnum">SDLEnum</a></span><span class="p">)</span><span class="nv">enumObj</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">isEqual</span><span class="p">(</span><span class="n">toEnum</span> <span class="nv">enumObj</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLEnum.h@T@SDLEnum">SDLEnum</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>

  
  <h4>Parameters</h4>
  <dl>
      <dt>enumObj</dt>
      <dd><p>A SDLEnum object</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>YES if the two enums are equal. NO if not.</p>
  </div>
  
</section>