swfdec-swfdecasvalue.html

Swfdec is a decoder/renderer for Macromedia Flash animations. The decoding and rendering engine is

<tr>
<td><span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td> value to convert
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> either <code class="literal">TRUE</code> or <code class="literal">FALSE</code>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2619264"></a><h3>
<a name="SWFDEC-AS-VALUE-SET-BOOLEAN:CAPS"></a>SWFDEC_AS_VALUE_SET_BOOLEAN()</h3>
<a class="indexterm" name="id2619275"></a><pre class="programlisting">#define             SWFDEC_AS_VALUE_SET_BOOLEAN(val,b)</pre>
<p>
Sets <em class="parameter"><code>val</code></em> to the specified boolean value.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>val</code></em>&#160;:</span></td>
<td> value to set
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>b</code></em>&#160;:</span></td>
<td> boolean value to set, must be either <code class="literal">TRUE</code> or <code class="literal">FALSE</code>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2619346"></a><h3>
<a name="SWFDEC-AS-VALUE-GET-NUMBER:CAPS"></a>SWFDEC_AS_VALUE_GET_NUMBER()</h3>
<a class="indexterm" name="id2619358"></a><pre class="programlisting">#define SWFDEC_AS_VALUE_GET_NUMBER(val) ((val)-&gt;value.number)
</pre>
<p>
Gets the number associated with <em class="parameter"><code>val</code></em>. If you are not sure that the value is
a valid number value, consider using <a href="swfdec-SwfdecAsValue.html#swfdec-as-value-to-number"><code class="function">swfdec_as_value_to_number()</code></a> or 
<code class="function">swfdec_as_value_to_int()</code> instead.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>val</code></em>&#160;:</span></td>
<td> value to get, the value must reference a number
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2619421"></a><h3>
<a name="swfdec-as-value-to-number"></a>swfdec_as_value_to_number ()</h3>
<a class="indexterm" name="id2619433"></a><pre class="programlisting">double              swfdec_as_value_to_number           (<a href="SwfdecAsContext.html" title="SwfdecAsContext">SwfdecAsContext</a> *context,
                                                         const <a href="swfdec-SwfdecAsValue.html#SwfdecAsValue">SwfdecAsValue</a> *value);</pre>
<p>
Converts the value to a number according to Flash's conversion routines and
the current Flash version. This conversion routine is similar, but not equal
to ECMAScript. For objects, it can call back into the script engine by 
calling the object's valueOf function.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>context</code></em>&#160;:</span></td>
<td> a <a href="SwfdecAsContext.html" title="SwfdecAsContext"><span class="type">SwfdecAsContext</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td> a <a href="swfdec-SwfdecAsValue.html#SwfdecAsValue"><span class="type">SwfdecAsValue</span></a> used by context
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a double value. It can be NaN or +-Infinity. It will not be -0.0.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2619535"></a><h3>
<a name="swfdec-as-value-to-integer"></a>swfdec_as_value_to_integer ()</h3>
<a class="indexterm" name="id2619547"></a><pre class="programlisting">int                 swfdec_as_value_to_integer          (<a href="SwfdecAsContext.html" title="SwfdecAsContext">SwfdecAsContext</a> *context,
                                                         const <a href="swfdec-SwfdecAsValue.html#SwfdecAsValue">SwfdecAsValue</a> *value);</pre>
<p>
Converts the given value to an integer. This is done similar to the 
conversion used by <a href="swfdec-SwfdecAsValue.html#swfdec-as-value-to-number"><code class="function">swfdec_as_value_to_number()</code></a>.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>context</code></em>&#160;:</span></td>
<td> a <a href="SwfdecAsContext.html" title="SwfdecAsContext"><span class="type">SwfdecAsContext</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td> value to convert
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> An Integer that can be represented in 32 bits.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2619647"></a><h3>
<a name="SWFDEC-AS-VALUE-SET-INT:CAPS"></a>SWFDEC_AS_VALUE_SET_INT()</h3>
<a class="indexterm" name="id2619660"></a><pre class="programlisting">#define SWFDEC_AS_VALUE_SET_INT(val,d) SWFDEC_AS_VALUE_SET_NUMBER(val,d)
</pre>
<p>
Sets <em class="parameter"><code>val</code></em> to the given value. Currently this macro is equivalent to
<a href="swfdec-SwfdecAsValue.html#SWFDEC-AS-VALUE-SET-NUMBER:CAPS"><code class="function">SWFDEC_AS_VALUE_SET_NUMBER()</code></a>, but this may change in future versions of
Swfdec.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>val</code></em>&#160;:</span></td>
<td> value to set
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>d</code></em>&#160;:</span></td>
<td> integer value to set
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2619730"></a><h3>
<a name="SWFDEC-AS-VALUE-SET-NUMBER:CAPS"></a>SWFDEC_AS_VALUE_SET_NUMBER()</h3>
<a class="indexterm" name="id2619744"></a><pre class="programlisting">#define             SWFDEC_AS_VALUE_SET_NUMBER(val,d)</pre>
<p>
Sets <em class="parameter"><code>val</code></em> to the given value. If you are sure the value is a valid
integer value, use <a href="swfdec-SwfdecAsValue.html#SWFDEC-AS-VALUE-SET-INT:CAPS"><code class="function">SWFDEC_AS_VALUE_SET_INT()</code></a> instead.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>val</code></em>&#160;:</span></td>
<td> value to set
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>d</code></em>&#160;:</span></td>
<td> double value to set
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2619813"></a><h3>
<a name="SWFDEC-AS-VALUE-GET-STRING:CAPS"></a>SWFDEC_AS_VALUE_GET_STRING()</h3>
<a class="indexterm" name="id2619826"></a><pre class="programlisting">#define SWFDEC_AS_VALUE_GET_STRING(val) ((val)-&gt;value.string)
</pre>
<p>
Gets the string associated with <em class="parameter"><code>val</code></em>. If you are not sure that the value is
a string value, consider using <a href="swfdec-SwfdecAsValue.html#swfdec-as-value-to-string"><code class="function">swfdec_as_value_to_string()</code></a> instead.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>val</code></em>&#160;:</span></td>
<td> value to get, the value must reference a string
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2619882"></a><h3>
<a name="swfdec-as-value-to-string"></a>swfdec_as_value_to_string ()</h3>
<a class="indexterm" name="id2619894"></a><pre class="programlisting">const char*         swfdec_as_value_to_string           (<a href="SwfdecAsContext.html" title="SwfdecAsContext">SwfdecAsContext</a> *context,
                                                         const <a href="swfdec-SwfdecAsValue.html#SwfdecAsValue">SwfdecAsValue</a> *value);</pre>
<p>
Converts <em class="parameter"><code>value</code></em> to a string according to the rules of Flash. This might 
cause calling back into the script engine if the <em class="parameter"><code>value</code></em> is an object. In
that case, the object's valueOf function is called. 
</p>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>Never use this function for debugging purposes.</div>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>context</code></em>&#160;:</span></td>
<td> a <a href="SwfdecAsContext.html" title="SwfdecAsContext"><span class="type">SwfdecAsContext</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td> value to be expressed as string
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a garbage-collected string representing <em class="parameter"><code>value</code></em>. The value will 
         never be <code class="literal">NULL</code>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2620019"></a><h3>
<a name="SWFDEC-AS-VALUE-SET-STRING:CAPS"></a>SWFDEC_AS_VALUE_SET_STRING()</h3>
<a class="indexterm" name="id2620032"></a><pre class="programlisting">#define             SWFDEC_AS_VALUE_SET_STRING(val,s)</pre>
<p>
Sets <em class="parameter"><code>val</code></em> to the given string value.</p>
<p>