File: pycbf.html

package info (click to toggle)
cbflib 0.9.7%2Bdfsg1-5
links: PTS, VCS
area: main
in suites: forky, sid, trixie
size: 65,272 kB
sloc: ansic: 131,361; python: 22,780; sh: 3,108; makefile: 2,088; yacc: 659; java: 223; f90: 214; xml: 210; cpp: 58
file content (3036 lines) | stat: -rw-r--r-- 228,359 bytes
parent folder | download | duplicates (7)

<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module pycbf</title>
</head><body bgcolor="#f0f0f8">

<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>pycbf</strong></big></big> (version still_being_written, 14 Dec 2005)</font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:///D|/wright/cbflib/cbflib_0.7.7/pycbf/pycbf.py">d:\wright\cbflib\cbflib_0.7.7\pycbf\pycbf.py</a></font></td></tr></table>
    <p><tt>pycbf&nbsp;-&nbsp;python&nbsp;bindings&nbsp;to&nbsp;the&nbsp;CBFlib&nbsp;library<br>
&nbsp;<br>
A&nbsp;library&nbsp;for&nbsp;reading&nbsp;and&nbsp;writing&nbsp;ImageCIF&nbsp;and&nbsp;CBF&nbsp;files&nbsp;<br>
which&nbsp;store&nbsp;area&nbsp;detector&nbsp;images&nbsp;for&nbsp;crystallography.<br>
&nbsp;<br>
This&nbsp;work&nbsp;is&nbsp;a&nbsp;derivative&nbsp;of&nbsp;the&nbsp;CBFlib&nbsp;version&nbsp;0.7.7&nbsp;library<br>
by&nbsp;&nbsp;Paul&nbsp;J.&nbsp;Ellis&nbsp;of&nbsp;Stanford&nbsp;Synchrotron&nbsp;Radiation&nbsp;Laboratory<br>
and&nbsp;Herbert&nbsp;J.&nbsp;Bernstein&nbsp;of&nbsp;Bernstein&nbsp;+&nbsp;Sons<br>
See:<br>
&nbsp;&nbsp;<a href="http://www.bernstein-plus-sons.com/software/CBF/">http://www.bernstein-plus-sons.com/software/CBF/</a><br>
&nbsp;<br>
Licensing&nbsp;is&nbsp;GPL&nbsp;based,&nbsp;see:<br>
&nbsp;&nbsp;<a href="http://www.bernstein-plus-sons.com/software/CBF/doc/CBFlib_NOTICES.html">http://www.bernstein-plus-sons.com/software/CBF/doc/CBFlib_NOTICES.html</a><br>
&nbsp;<br>
These&nbsp;bindings&nbsp;were&nbsp;automatically&nbsp;generated&nbsp;by&nbsp;SWIG,&nbsp;and&nbsp;the<br>
input&nbsp;to&nbsp;SWIG&nbsp;was&nbsp;automatically&nbsp;generated&nbsp;by&nbsp;a&nbsp;python&nbsp;script.<br>
We&nbsp;very&nbsp;strongly&nbsp;recommend&nbsp;you&nbsp;do&nbsp;not&nbsp;attempt&nbsp;to&nbsp;edit&nbsp;them&nbsp;<br>
by&nbsp;hand!<br>
&nbsp;<br>
&nbsp;<br>
&nbsp;<br>
Copyright&nbsp;(C)&nbsp;2007&nbsp;&nbsp;&nbsp;&nbsp;Jonathan&nbsp;Wright<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ESRF,&nbsp;Grenoble,&nbsp;France<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;email:&nbsp;wright@esrf.fr</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
    
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="_pycbf.html">_pycbf</a><br>
</td><td width="25%" valign=top><a href="new.html">new</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
    
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="pycbf.html#cbf_detector_struct">cbf_detector_struct</a>
</font></dt><dt><font face="helvetica, arial"><a href="pycbf.html#cbf_handle_struct">cbf_handle_struct</a>
</font></dt><dt><font face="helvetica, arial"><a href="pycbf.html#cbf_positioner_struct">cbf_positioner_struct</a>
</font></dt></dl>
</dd>
</dl>
 <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="cbf_detector_struct">class <strong>cbf_detector_struct</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
    
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>Proxy&nbsp;of&nbsp;C&nbsp;<a href="#cbf_detector_struct">cbf_detector_struct</a>&nbsp;struct<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><strong>__del__</strong> <em>lambda</em> self</dt></dl>

<dl><dt><strong>__getattr__</strong> <em>lambda</em> self, name</dt></dl>

<dl><dt><a name="cbf_detector_struct-__init__"><strong>__init__</strong></a>(self, *args)</dt><dd><tt><a href="#cbf_detector_struct-__init__">__init__</a>(self)&nbsp;-&gt;&nbsp;<a href="#cbf_detector_struct">cbf_detector_struct</a></tt></dd></dl>

<dl><dt><a name="cbf_detector_struct-__repr__"><strong>__repr__</strong></a> = _swig_repr(self)</dt></dl>

<dl><dt><strong>__setattr__</strong> <em>lambda</em> self, name, value</dt></dl>

<dl><dt><a name="cbf_detector_struct-get_beam_center"><strong>get_beam_center</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;double&nbsp;index1,double&nbsp;index2,double&nbsp;center1,double&nbsp;center2<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_beam_center&nbsp;(cbf_detector&nbsp;detector,&nbsp;double&nbsp;*index1,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;&nbsp;&nbsp;&nbsp;*index2,&nbsp;double&nbsp;*center1,&nbsp;double&nbsp;*center2);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_beam_center&nbsp;sets&nbsp;*center1&nbsp;and&nbsp;*center2&nbsp;to&nbsp;the&nbsp;displacements&nbsp;<br>
in&nbsp;mm&nbsp;along&nbsp;the&nbsp;detector&nbsp;axes&nbsp;from&nbsp;pixel&nbsp;(0,&nbsp;0)&nbsp;to&nbsp;the&nbsp;point&nbsp;at&nbsp;which&nbsp;<br>
the&nbsp;beam&nbsp;intersects&nbsp;the&nbsp;detector&nbsp;and&nbsp;*index1&nbsp;and&nbsp;*index2&nbsp;to&nbsp;the&nbsp;<br>
corresponding&nbsp;indices.&nbsp;cbf_set_beam_center&nbsp;sets&nbsp;the&nbsp;offsets&nbsp;in&nbsp;the&nbsp;<br>
axis&nbsp;category&nbsp;for&nbsp;the&nbsp;detector&nbsp;element&nbsp;axis&nbsp;with&nbsp;precedence&nbsp;1&nbsp;to&nbsp;<br>
place&nbsp;the&nbsp;beam&nbsp;center&nbsp;at&nbsp;the&nbsp;position&nbsp;given&nbsp;in&nbsp;mm&nbsp;by&nbsp;*center1&nbsp;and&nbsp;<br>
*center2&nbsp;as&nbsp;the&nbsp;displacements&nbsp;in&nbsp;mm&nbsp;along&nbsp;the&nbsp;detector&nbsp;axes&nbsp;from&nbsp;<br>
pixel&nbsp;(0,&nbsp;0)&nbsp;to&nbsp;the&nbsp;point&nbsp;at&nbsp;which&nbsp;the&nbsp;beam&nbsp;intersects&nbsp;the&nbsp;detector&nbsp;<br>
at&nbsp;the&nbsp;indices&nbsp;given&nbsp;*index1&nbsp;and&nbsp;*index2.<br>
Any&nbsp;of&nbsp;the&nbsp;destination&nbsp;pointers&nbsp;may&nbsp;be&nbsp;NULL&nbsp;for&nbsp;getting&nbsp;the&nbsp;beam&nbsp;<br>
center.&nbsp;For&nbsp;setting&nbsp;the&nbsp;beam&nbsp;axis,&nbsp;either&nbsp;the&nbsp;indices&nbsp;of&nbsp;the&nbsp;center&nbsp;<br>
must&nbsp;not&nbsp;be&nbsp;NULL.<br>
The&nbsp;indices&nbsp;are&nbsp;non-negative&nbsp;for&nbsp;beam&nbsp;centers&nbsp;within&nbsp;the&nbsp;detector&nbsp;<br>
surface,&nbsp;but&nbsp;the&nbsp;center&nbsp;for&nbsp;an&nbsp;axis&nbsp;with&nbsp;a&nbsp;negative&nbsp;increment&nbsp;will&nbsp;be&nbsp;<br>
negative&nbsp;for&nbsp;a&nbsp;beam&nbsp;center&nbsp;within&nbsp;the&nbsp;detector&nbsp;surface.<br>
ARGUMENTS<br>
detector&nbsp;&nbsp;&nbsp;Detector&nbsp;handle.&nbsp;index1&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;slow&nbsp;<br>
index.&nbsp;index2&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;fast&nbsp;index.&nbsp;center1&nbsp;&nbsp;&nbsp;<br>
Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;displacement&nbsp;along&nbsp;the&nbsp;slow&nbsp;axis.&nbsp;center2&nbsp;&nbsp;<br>
&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;displacement&nbsp;along&nbsp;the&nbsp;fast&nbsp;axis.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_detector_struct-get_detector_distance"><strong>get_detector_distance</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;double&nbsp;distance<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_detector_distance&nbsp;(cbf_detector&nbsp;detector,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;&nbsp;&nbsp;&nbsp;*distance);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_detector_distance&nbsp;sets&nbsp;*distance&nbsp;to&nbsp;the&nbsp;nearest&nbsp;distance&nbsp;from&nbsp;<br>
the&nbsp;sample&nbsp;position&nbsp;to&nbsp;the&nbsp;detector&nbsp;plane.<br>
ARGUMENTS<br>
detector&nbsp;&nbsp;&nbsp;Detector&nbsp;handle.&nbsp;distance&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;<br>
distance.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_detector_struct-get_detector_normal"><strong>get_detector_normal</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;double&nbsp;normal1,double&nbsp;normal2,double&nbsp;normal3<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_detector_normal&nbsp;(cbf_detector&nbsp;detector,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;*normal1,&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;*normal2,&nbsp;double&nbsp;*normal3);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_detector_normal&nbsp;sets&nbsp;*normal1,&nbsp;*normal2,&nbsp;and&nbsp;*normal3&nbsp;to&nbsp;the&nbsp;<br>
3&nbsp;components&nbsp;of&nbsp;the&nbsp;of&nbsp;the&nbsp;normal&nbsp;vector&nbsp;to&nbsp;the&nbsp;detector&nbsp;plane.&nbsp;The&nbsp;<br>
vector&nbsp;is&nbsp;normalized.<br>
Any&nbsp;of&nbsp;the&nbsp;destination&nbsp;pointers&nbsp;may&nbsp;be&nbsp;NULL.<br>
ARGUMENTS<br>
detector&nbsp;&nbsp;&nbsp;Detector&nbsp;handle.&nbsp;normal1&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;x&nbsp;<br>
component&nbsp;of&nbsp;the&nbsp;normal&nbsp;vector.&nbsp;normal2&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;<br>
y&nbsp;component&nbsp;of&nbsp;the&nbsp;normal&nbsp;vector.&nbsp;normal3&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;<br>
destination&nbsp;z&nbsp;component&nbsp;of&nbsp;the&nbsp;normal&nbsp;vector.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_detector_struct-get_inferred_pixel_size"><strong>get_inferred_pixel_size</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;Float&nbsp;pixel&nbsp;size<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;Int&nbsp;axis_number<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_inferred_pixel_size&nbsp;(cbf_detector&nbsp;detector,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;&nbsp;&nbsp;&nbsp;axis_number,&nbsp;double&nbsp;*psize);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_inferred_pixel_size&nbsp;sets&nbsp;*psize&nbsp;to&nbsp;point&nbsp;to&nbsp;the&nbsp;double&nbsp;value&nbsp;<br>
in&nbsp;millimeters&nbsp;of&nbsp;the&nbsp;pixel&nbsp;size&nbsp;for&nbsp;the&nbsp;axis&nbsp;axis_number&nbsp;value&nbsp;for&nbsp;<br>
pixel&nbsp;at&nbsp;(index1,&nbsp;index2)&nbsp;on&nbsp;the&nbsp;detector&nbsp;surface.&nbsp;The&nbsp;slow&nbsp;index&nbsp;is&nbsp;<br>
treated&nbsp;as&nbsp;axis&nbsp;1&nbsp;and&nbsp;the&nbsp;fast&nbsp;index&nbsp;is&nbsp;treated&nbsp;as&nbsp;axis&nbsp;2.<br>
ARGUMENTS<br>
detector&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Detector&nbsp;handle.&nbsp;axis_number&nbsp;&nbsp;&nbsp;The&nbsp;number&nbsp;of&nbsp;the&nbsp;axis.&nbsp;<br>
area&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;pizel&nbsp;size&nbsp;in&nbsp;mm.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_detector_struct-get_pixel_area"><strong>get_pixel_area</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;double&nbsp;area,double&nbsp;projected_area<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;double&nbsp;index1,double&nbsp;index2<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_pixel_area&nbsp;(cbf_detector&nbsp;detector,&nbsp;double&nbsp;index1,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;&nbsp;&nbsp;&nbsp;index2,&nbsp;double&nbsp;*area,&nbsp;double&nbsp;*projected_area);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_pixel_area&nbsp;sets&nbsp;*area&nbsp;to&nbsp;the&nbsp;area&nbsp;of&nbsp;the&nbsp;pixel&nbsp;at&nbsp;(index1,&nbsp;<br>
index2)&nbsp;on&nbsp;the&nbsp;detector&nbsp;surface&nbsp;and&nbsp;*projected_area&nbsp;to&nbsp;the&nbsp;apparent&nbsp;<br>
area&nbsp;of&nbsp;the&nbsp;pixel&nbsp;as&nbsp;viewed&nbsp;from&nbsp;the&nbsp;sample&nbsp;position.<br>
Either&nbsp;of&nbsp;the&nbsp;destination&nbsp;pointers&nbsp;may&nbsp;be&nbsp;NULL.<br>
ARGUMENTS<br>
detector&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Detector&nbsp;handle.&nbsp;index1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Slow&nbsp;index.&nbsp;index2&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Fast&nbsp;index.&nbsp;area&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;<br>
area&nbsp;in&nbsp;mm2.&nbsp;projected_area&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;apparent&nbsp;<br>
area&nbsp;in&nbsp;mm2.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_detector_struct-get_pixel_coordinates"><strong>get_pixel_coordinates</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;double&nbsp;coordinate1,double&nbsp;coordinate2,double&nbsp;coordinate3<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;double&nbsp;index1,double&nbsp;index2<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_pixel_coordinates&nbsp;(cbf_detector&nbsp;detector,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;index1,&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;index2,&nbsp;double&nbsp;*coordinate1,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;*coordinate2,&nbsp;double&nbsp;&nbsp;&nbsp;&nbsp;*coordinate3);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_pixel_coordinates&nbsp;sets&nbsp;*coordinate1,&nbsp;*coordinate2,&nbsp;and&nbsp;<br>
*coordinate3&nbsp;to&nbsp;the&nbsp;vector&nbsp;position&nbsp;of&nbsp;pixel&nbsp;(index1,&nbsp;index2)&nbsp;on&nbsp;the&nbsp;<br>
detector&nbsp;surface.&nbsp;If&nbsp;index1&nbsp;and&nbsp;index2&nbsp;are&nbsp;integers&nbsp;then&nbsp;the&nbsp;<br>
coordinates&nbsp;correspond&nbsp;to&nbsp;the&nbsp;center&nbsp;of&nbsp;a&nbsp;pixel.<br>
Any&nbsp;of&nbsp;the&nbsp;destination&nbsp;pointers&nbsp;may&nbsp;be&nbsp;NULL.<br>
ARGUMENTS<br>
detector&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Detector&nbsp;handle.&nbsp;index1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Slow&nbsp;index.&nbsp;index2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>
&nbsp;Fast&nbsp;index.&nbsp;coordinate1&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;x&nbsp;component.&nbsp;<br>
coordinate2&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;y&nbsp;component.&nbsp;coordinate3&nbsp;&nbsp;&nbsp;<br>
Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;z&nbsp;component.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_detector_struct-get_pixel_normal"><strong>get_pixel_normal</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;double&nbsp;normal1,double&nbsp;normal2,double&nbsp;normal3<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;double&nbsp;index1,double&nbsp;index2<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_pixel_normal&nbsp;(cbf_detector&nbsp;detector,&nbsp;double&nbsp;index1,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;&nbsp;&nbsp;&nbsp;index2,&nbsp;double&nbsp;*normal1,&nbsp;double&nbsp;*normal2,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;*normal3);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_detector_normal&nbsp;sets&nbsp;*normal1,&nbsp;*normal2,&nbsp;and&nbsp;*normal3&nbsp;to&nbsp;the&nbsp;<br>
3&nbsp;components&nbsp;of&nbsp;the&nbsp;of&nbsp;the&nbsp;normal&nbsp;vector&nbsp;to&nbsp;the&nbsp;pixel&nbsp;at&nbsp;(index1,&nbsp;<br>
index2).&nbsp;The&nbsp;vector&nbsp;is&nbsp;normalized.<br>
Any&nbsp;of&nbsp;the&nbsp;destination&nbsp;pointers&nbsp;may&nbsp;be&nbsp;NULL.<br>
ARGUMENTS<br>
detector&nbsp;&nbsp;&nbsp;Detector&nbsp;handle.&nbsp;index1&nbsp;&nbsp;&nbsp;Slow&nbsp;index.&nbsp;index2&nbsp;&nbsp;&nbsp;Fast&nbsp;index.&nbsp;<br>
normal1&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;x&nbsp;component&nbsp;of&nbsp;the&nbsp;normal&nbsp;<br>
vector.&nbsp;normal2&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;y&nbsp;component&nbsp;of&nbsp;the&nbsp;<br>
normal&nbsp;vector.&nbsp;normal3&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;z&nbsp;component&nbsp;of&nbsp;<br>
the&nbsp;normal&nbsp;vector.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<hr>
Properties defined here:<br>
<dl><dt><strong>axes</strong></dt>
<dd><dl><dt><a name="-<em>get</em>"><strong><em>get</em></strong></a> = cbf_detector_struct_axes_get(...)</dt></dl>
</dd>
<dd><dl><dt><a name="-<em>set</em>"><strong><em>set</em></strong></a> = cbf_detector_struct_axes_set(...)</dt></dl>
</dd>
</dl>
<dl><dt><strong>displacement</strong></dt>
<dd><dl><dt><a name="-<em>get</em>"><strong><em>get</em></strong></a> = cbf_detector_struct_displacement_get(...)</dt></dl>
</dd>
<dd><dl><dt><a name="-<em>set</em>"><strong><em>set</em></strong></a> = cbf_detector_struct_displacement_set(...)</dt></dl>
</dd>
</dl>
<dl><dt><strong>increment</strong></dt>
<dd><dl><dt><a name="-<em>get</em>"><strong><em>get</em></strong></a> = cbf_detector_struct_increment_get(...)</dt></dl>
</dd>
<dd><dl><dt><a name="-<em>set</em>"><strong><em>set</em></strong></a> = cbf_detector_struct_increment_set(...)</dt></dl>
</dd>
</dl>
<dl><dt><strong>index</strong></dt>
<dd><dl><dt><a name="-<em>get</em>"><strong><em>get</em></strong></a> = cbf_detector_struct_index_get(...)</dt></dl>
</dd>
<dd><dl><dt><a name="-<em>set</em>"><strong><em>set</em></strong></a> = cbf_detector_struct_index_set(...)</dt></dl>
</dd>
</dl>
<dl><dt><strong>positioner</strong></dt>
<dd><dl><dt><a name="-<em>get</em>"><strong><em>get</em></strong></a> = cbf_detector_struct_positioner_get(...)</dt></dl>
</dd>
<dd><dl><dt><a name="-<em>set</em>"><strong><em>set</em></strong></a> = cbf_detector_struct_positioner_set(...)</dt></dl>
</dd>
</dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>__dict__</strong> = &lt;dictproxy object&gt;<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dl>

<dl><dt><strong>__swig_destroy__</strong> = &lt;built-in function delete_cbf_detector_struct&gt;</dl>

<dl><dt><strong>__swig_getmethods__</strong> = {'axes': &lt;built-in function cbf_detector_struct_axes_get&gt;, 'displacement': &lt;built-in function cbf_detector_struct_displacement_get&gt;, 'increment': &lt;built-in function cbf_detector_struct_increment_get&gt;, 'index': &lt;built-in function cbf_detector_struct_index_get&gt;, 'positioner': &lt;built-in function cbf_detector_struct_positioner_get&gt;}</dl>

<dl><dt><strong>__swig_setmethods__</strong> = {'axes': &lt;built-in function cbf_detector_struct_axes_set&gt;, 'displacement': &lt;built-in function cbf_detector_struct_displacement_set&gt;, 'increment': &lt;built-in function cbf_detector_struct_increment_set&gt;, 'index': &lt;built-in function cbf_detector_struct_index_set&gt;, 'positioner': &lt;built-in function cbf_detector_struct_positioner_set&gt;}</dl>

<dl><dt><strong>__weakref__</strong> = &lt;attribute '__weakref__' of 'cbf_detector_struct' objects&gt;<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;(if&nbsp;defined)</tt></dl>

</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="cbf_handle_struct">class <strong>cbf_handle_struct</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
    
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>Proxy&nbsp;of&nbsp;C&nbsp;<a href="#cbf_handle_struct">cbf_handle_struct</a>&nbsp;struct<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><strong>__del__</strong> <em>lambda</em> self</dt></dl>

<dl><dt><strong>__getattr__</strong> <em>lambda</em> self, name</dt></dl>

<dl><dt><a name="cbf_handle_struct-__init__"><strong>__init__</strong></a>(self, *args)</dt><dd><tt><a href="#cbf_handle_struct-__init__">__init__</a>(self)&nbsp;-&gt;&nbsp;<a href="#cbf_handle_struct">cbf_handle_struct</a></tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-__repr__"><strong>__repr__</strong></a> = _swig_repr(self)</dt></dl>

<dl><dt><strong>__setattr__</strong> <em>lambda</em> self, name, value</dt></dl>

<dl><dt><a name="cbf_handle_struct-category_name"><strong>category_name</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;string<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_category_name&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char&nbsp;**categoryname);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_category_name&nbsp;sets&nbsp;*categoryname&nbsp;to&nbsp;point&nbsp;to&nbsp;the&nbsp;name&nbsp;of&nbsp;the&nbsp;<br>
current&nbsp;category&nbsp;of&nbsp;the&nbsp;current&nbsp;data&nbsp;block.<br>
The&nbsp;category&nbsp;name&nbsp;will&nbsp;be&nbsp;valid&nbsp;as&nbsp;long&nbsp;as&nbsp;the&nbsp;category&nbsp;exists.<br>
The&nbsp;name&nbsp;must&nbsp;not&nbsp;be&nbsp;modified&nbsp;by&nbsp;the&nbsp;program&nbsp;in&nbsp;any&nbsp;way.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;categoryname&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;<br>
category&nbsp;name&nbsp;pointer.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-column_name"><strong>column_name</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;string<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_column_name&nbsp;(cbf_handle&nbsp;handle,&nbsp;const&nbsp;char&nbsp;**columnname);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_column_name&nbsp;sets&nbsp;*columnname&nbsp;to&nbsp;point&nbsp;to&nbsp;the&nbsp;name&nbsp;of&nbsp;the&nbsp;current&nbsp;<br>
column&nbsp;of&nbsp;the&nbsp;current&nbsp;category.<br>
The&nbsp;column&nbsp;name&nbsp;will&nbsp;be&nbsp;valid&nbsp;as&nbsp;long&nbsp;as&nbsp;the&nbsp;column&nbsp;exists.<br>
The&nbsp;name&nbsp;must&nbsp;not&nbsp;be&nbsp;modified&nbsp;by&nbsp;the&nbsp;program&nbsp;in&nbsp;any&nbsp;way.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;columnname&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;<br>
column&nbsp;name&nbsp;pointer.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-construct_detector"><strong>construct_detector</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;pycbf&nbsp;detector&nbsp;<a href="__builtin__.html#object">object</a><br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;Integer&nbsp;element_number<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_construct_detector&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;cbf_detector&nbsp;*detector,&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;element_number);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_construct_detector&nbsp;constructs&nbsp;a&nbsp;detector&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;for&nbsp;detector&nbsp;<br>
element&nbsp;number&nbsp;element_number&nbsp;using&nbsp;the&nbsp;description&nbsp;in&nbsp;the&nbsp;CBF&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;<br>
handle&nbsp;and&nbsp;initialises&nbsp;the&nbsp;detector&nbsp;handle&nbsp;*detector.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;detector&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;detector&nbsp;<br>
handle.&nbsp;element_number&nbsp;&nbsp;&nbsp;The&nbsp;number&nbsp;of&nbsp;the&nbsp;detector&nbsp;element&nbsp;counting&nbsp;<br>
from&nbsp;0&nbsp;by&nbsp;order&nbsp;of&nbsp;appearance&nbsp;in&nbsp;the&nbsp;"diffrn_data_frame"&nbsp;category.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-construct_goniometer"><strong>construct_goniometer</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;pycbf&nbsp;goniometer&nbsp;<a href="__builtin__.html#object">object</a><br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_construct_goniometer&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;cbf_goniometer&nbsp;&nbsp;&nbsp;&nbsp;*goniometer);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_construct_goniometer&nbsp;constructs&nbsp;a&nbsp;goniometer&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;using&nbsp;the&nbsp;<br>
description&nbsp;in&nbsp;the&nbsp;CBF&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;handle&nbsp;and&nbsp;initialises&nbsp;the&nbsp;goniometer&nbsp;<br>
handle&nbsp;*goniometer.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;goniometer&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;<br>
goniometer&nbsp;handle.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-count_categories"><strong>count_categories</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;unsigned<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_count_categories&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;&nbsp;&nbsp;&nbsp;*categories);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_count_categories&nbsp;puts&nbsp;the&nbsp;number&nbsp;of&nbsp;categories&nbsp;in&nbsp;the&nbsp;current&nbsp;<br>
data&nbsp;block&nbsp;in&nbsp;*categories.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;categories&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;<br>
category&nbsp;count.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-count_columns"><strong>count_columns</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;Integer<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_count_columns&nbsp;(cbf_handle&nbsp;handle,&nbsp;unsigned&nbsp;int&nbsp;*columns);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_count_columns&nbsp;puts&nbsp;the&nbsp;number&nbsp;of&nbsp;columns&nbsp;in&nbsp;the&nbsp;current&nbsp;category&nbsp;<br>
in&nbsp;*columns.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;columns&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;column&nbsp;<br>
count.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-count_datablocks"><strong>count_datablocks</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;unsigned<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_count_datablocks&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;&nbsp;&nbsp;&nbsp;*datablocks);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_count_datablocks&nbsp;puts&nbsp;the&nbsp;number&nbsp;of&nbsp;data&nbsp;blocks&nbsp;in&nbsp;*datablocks&nbsp;.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;datablocks&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;data&nbsp;<br>
block&nbsp;count.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-count_elements"><strong>count_elements</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;Integer<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_count_elements&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;*elements);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_count_elements&nbsp;sets&nbsp;*elements&nbsp;to&nbsp;the&nbsp;number&nbsp;of&nbsp;detector&nbsp;elements.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;elements&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;count.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-count_rows"><strong>count_rows</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;Integer<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_count_rows&nbsp;(cbf_handle&nbsp;handle,&nbsp;unsigned&nbsp;int&nbsp;*rows);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_count_rows&nbsp;puts&nbsp;the&nbsp;number&nbsp;of&nbsp;rows&nbsp;in&nbsp;the&nbsp;current&nbsp;category&nbsp;in&nbsp;<br>
*rows&nbsp;.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;rows&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;row&nbsp;count.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-datablock_name"><strong>datablock_name</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;string<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_datablock_name&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char&nbsp;&nbsp;&nbsp;&nbsp;**datablockname);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_datablock_name&nbsp;sets&nbsp;*datablockname&nbsp;to&nbsp;point&nbsp;to&nbsp;the&nbsp;name&nbsp;of&nbsp;the&nbsp;<br>
current&nbsp;data&nbsp;block.<br>
The&nbsp;data&nbsp;block&nbsp;name&nbsp;will&nbsp;be&nbsp;valid&nbsp;as&nbsp;long&nbsp;as&nbsp;the&nbsp;data&nbsp;block&nbsp;exists&nbsp;<br>
and&nbsp;has&nbsp;not&nbsp;been&nbsp;renamed.<br>
The&nbsp;name&nbsp;must&nbsp;not&nbsp;be&nbsp;modified&nbsp;by&nbsp;the&nbsp;program&nbsp;in&nbsp;any&nbsp;way.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;datablockname&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;<br>
destination&nbsp;data&nbsp;block&nbsp;name&nbsp;pointer.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-delete_row"><strong>delete_row</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;Integer<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_delete_row&nbsp;(cbf_handle&nbsp;handle,&nbsp;unsigned&nbsp;int&nbsp;rownumber);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_delete_row&nbsp;deletes&nbsp;a&nbsp;row&nbsp;from&nbsp;the&nbsp;current&nbsp;category.&nbsp;Rows&nbsp;starting&nbsp;<br>
from&nbsp;rownumber&nbsp;+1&nbsp;are&nbsp;moved&nbsp;down&nbsp;by&nbsp;1.&nbsp;If&nbsp;the&nbsp;current&nbsp;row&nbsp;was&nbsp;higher&nbsp;<br>
than&nbsp;rownumber,&nbsp;or&nbsp;if&nbsp;the&nbsp;current&nbsp;row&nbsp;is&nbsp;the&nbsp;last&nbsp;row,&nbsp;it&nbsp;will&nbsp;also&nbsp;<br>
move&nbsp;down&nbsp;by&nbsp;1.<br>
The&nbsp;row&nbsp;numbers&nbsp;start&nbsp;from&nbsp;0.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;rownumber&nbsp;&nbsp;&nbsp;The&nbsp;number&nbsp;of&nbsp;the&nbsp;row&nbsp;to&nbsp;delete.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-find_category"><strong>find_category</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;string<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_find_category&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char&nbsp;*categoryname);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_find_category&nbsp;makes&nbsp;the&nbsp;category&nbsp;in&nbsp;the&nbsp;current&nbsp;data&nbsp;block&nbsp;with&nbsp;<br>
name&nbsp;categoryname&nbsp;the&nbsp;current&nbsp;category.<br>
The&nbsp;comparison&nbsp;is&nbsp;case-insensitive.<br>
If&nbsp;the&nbsp;category&nbsp;does&nbsp;not&nbsp;exist,&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_NOTFOUND.<br>
The&nbsp;current&nbsp;column&nbsp;and&nbsp;row&nbsp;become&nbsp;undefined.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;categoryname&nbsp;&nbsp;&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;category&nbsp;to&nbsp;<br>
find.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-find_category_root"><strong>find_category_root</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;String&nbsp;categoryroot<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;String&nbsp;categoryname<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_find_category_root&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char*&nbsp;&nbsp;&nbsp;&nbsp;categoryname,&nbsp;const&nbsp;char**&nbsp;categoryroot);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_find_category_root&nbsp;sets&nbsp;*categoryroot&nbsp;to&nbsp;the&nbsp;root&nbsp;category&nbsp;of&nbsp;<br>
which&nbsp;categoryname&nbsp;is&nbsp;an&nbsp;alias.&nbsp;cbf_set_category_root&nbsp;sets&nbsp;<br>
categoryname_in&nbsp;as&nbsp;an&nbsp;alias&nbsp;of&nbsp;categoryroot&nbsp;in&nbsp;the&nbsp;dictionary&nbsp;<br>
associated&nbsp;with&nbsp;handle,&nbsp;creating&nbsp;the&nbsp;dictionary&nbsp;if&nbsp;necessary.&nbsp;<br>
cbf_require_category_root&nbsp;sets&nbsp;*categoryroot&nbsp;to&nbsp;the&nbsp;root&nbsp;category&nbsp;of&nbsp;<br>
which&nbsp;categoryname&nbsp;is&nbsp;an&nbsp;alias,&nbsp;if&nbsp;there&nbsp;is&nbsp;one,&nbsp;or&nbsp;to&nbsp;the&nbsp;value&nbsp;of&nbsp;<br>
categoryname,&nbsp;if&nbsp;categoryname&nbsp;is&nbsp;not&nbsp;an&nbsp;alias.<br>
A&nbsp;returned&nbsp;categoryroot&nbsp;string&nbsp;must&nbsp;not&nbsp;be&nbsp;modified&nbsp;in&nbsp;any&nbsp;way.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;categoryname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;category&nbsp;name&nbsp;which&nbsp;<br>
may&nbsp;be&nbsp;an&nbsp;alias.&nbsp;categoryroot&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;pointer&nbsp;to&nbsp;a&nbsp;returned&nbsp;category&nbsp;<br>
root&nbsp;name.&nbsp;categoryroot_in&nbsp;&nbsp;&nbsp;input&nbsp;category&nbsp;root&nbsp;name.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-find_column"><strong>find_column</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;string<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_find_column&nbsp;(cbf_handle&nbsp;handle,&nbsp;const&nbsp;char&nbsp;*columnname);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_find_column&nbsp;makes&nbsp;the&nbsp;columns&nbsp;in&nbsp;the&nbsp;current&nbsp;category&nbsp;with&nbsp;name&nbsp;<br>
columnname&nbsp;the&nbsp;current&nbsp;column.<br>
The&nbsp;comparison&nbsp;is&nbsp;case-insensitive.<br>
If&nbsp;the&nbsp;column&nbsp;does&nbsp;not&nbsp;exist,&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_NOTFOUND.<br>
The&nbsp;current&nbsp;row&nbsp;is&nbsp;not&nbsp;affected.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;columnname&nbsp;&nbsp;&nbsp;The&nbsp;name&nbsp;of&nbsp;column&nbsp;to&nbsp;find.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-find_datablock"><strong>find_datablock</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;string<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_find_datablock&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char&nbsp;*datablockname);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_find_datablock&nbsp;makes&nbsp;the&nbsp;data&nbsp;block&nbsp;with&nbsp;name&nbsp;datablockname&nbsp;the&nbsp;<br>
current&nbsp;data&nbsp;block.<br>
The&nbsp;comparison&nbsp;is&nbsp;case-insensitive.<br>
If&nbsp;the&nbsp;data&nbsp;block&nbsp;does&nbsp;not&nbsp;exist,&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_NOTFOUND.<br>
The&nbsp;current&nbsp;category&nbsp;becomes&nbsp;undefined.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;datablockname&nbsp;&nbsp;&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;data&nbsp;<br>
block&nbsp;to&nbsp;find.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-find_nextrow"><strong>find_nextrow</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;string<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_find_nextrow&nbsp;(cbf_handle&nbsp;handle,&nbsp;const&nbsp;char&nbsp;*value);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_find_nextrow&nbsp;makes&nbsp;the&nbsp;makes&nbsp;the&nbsp;next&nbsp;row&nbsp;in&nbsp;the&nbsp;current&nbsp;column&nbsp;<br>
with&nbsp;value&nbsp;value&nbsp;the&nbsp;current&nbsp;row.&nbsp;The&nbsp;search&nbsp;starts&nbsp;from&nbsp;the&nbsp;row&nbsp;<br>
following&nbsp;the&nbsp;last&nbsp;row&nbsp;found&nbsp;with&nbsp;cbf_find_row&nbsp;or&nbsp;cbf_find_nextrow,&nbsp;<br>
or&nbsp;from&nbsp;the&nbsp;current&nbsp;row&nbsp;if&nbsp;the&nbsp;current&nbsp;row&nbsp;was&nbsp;defined&nbsp;using&nbsp;any&nbsp;<br>
other&nbsp;function.<br>
The&nbsp;comparison&nbsp;is&nbsp;case-sensitive.<br>
If&nbsp;no&nbsp;more&nbsp;matching&nbsp;rows&nbsp;exist,&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_NOTFOUND.<br>
The&nbsp;current&nbsp;column&nbsp;is&nbsp;not&nbsp;affected.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;value&nbsp;&nbsp;&nbsp;&nbsp;the&nbsp;value&nbsp;to&nbsp;search&nbsp;for.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-find_row"><strong>find_row</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;string<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_find_row&nbsp;(cbf_handle&nbsp;handle,&nbsp;const&nbsp;char&nbsp;*value);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_find_row&nbsp;makes&nbsp;the&nbsp;first&nbsp;row&nbsp;in&nbsp;the&nbsp;current&nbsp;column&nbsp;with&nbsp;value&nbsp;<br>
value&nbsp;the&nbsp;current&nbsp;row.<br>
The&nbsp;comparison&nbsp;is&nbsp;case-sensitive.<br>
If&nbsp;a&nbsp;matching&nbsp;row&nbsp;does&nbsp;not&nbsp;exist,&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_NOTFOUND.<br>
The&nbsp;current&nbsp;column&nbsp;is&nbsp;not&nbsp;affected.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;value&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;value&nbsp;of&nbsp;the&nbsp;row&nbsp;to&nbsp;find.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-find_tag_category"><strong>find_tag_category</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;String&nbsp;categoryname_in<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;String&nbsp;tagname<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_find_tag_category&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char*&nbsp;tagname,&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char**&nbsp;categoryname);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_find_tag_category&nbsp;sets&nbsp;categoryname&nbsp;to&nbsp;the&nbsp;category&nbsp;associated&nbsp;<br>
with&nbsp;tagname&nbsp;in&nbsp;the&nbsp;dictionary&nbsp;associated&nbsp;with&nbsp;handle.&nbsp;<br>
cbf_set_tag_category&nbsp;upddates&nbsp;the&nbsp;dictionary&nbsp;associated&nbsp;with&nbsp;handle&nbsp;<br>
to&nbsp;indicated&nbsp;that&nbsp;tagname&nbsp;is&nbsp;in&nbsp;category&nbsp;categoryname_in.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;tagname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;tag&nbsp;name.&nbsp;<br>
categoryname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;pointer&nbsp;to&nbsp;a&nbsp;returned&nbsp;category&nbsp;name.&nbsp;<br>
categoryname_in&nbsp;&nbsp;&nbsp;input&nbsp;category&nbsp;name.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-find_tag_root"><strong>find_tag_root</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;String&nbsp;tagroot<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;String&nbsp;tagname<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_find_tag_root&nbsp;(cbf_handle&nbsp;handle,&nbsp;const&nbsp;char*&nbsp;tagname,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;&nbsp;&nbsp;&nbsp;char**&nbsp;tagroot);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_find_tag_root&nbsp;sets&nbsp;*tagroot&nbsp;to&nbsp;the&nbsp;root&nbsp;tag&nbsp;of&nbsp;which&nbsp;tagname&nbsp;is&nbsp;<br>
an&nbsp;alias.&nbsp;cbf_set_tag_root&nbsp;sets&nbsp;tagname&nbsp;as&nbsp;an&nbsp;alias&nbsp;of&nbsp;tagroot_in&nbsp;in&nbsp;<br>
the&nbsp;dictionary&nbsp;associated&nbsp;with&nbsp;handle,&nbsp;creating&nbsp;the&nbsp;dictionary&nbsp;if&nbsp;<br>
necessary.&nbsp;cbf_require_tag_root&nbsp;sets&nbsp;*tagroot&nbsp;to&nbsp;the&nbsp;root&nbsp;tag&nbsp;of&nbsp;<br>
which&nbsp;tagname&nbsp;is&nbsp;an&nbsp;alias,&nbsp;if&nbsp;there&nbsp;is&nbsp;one,&nbsp;or&nbsp;to&nbsp;the&nbsp;value&nbsp;of&nbsp;<br>
tagname,&nbsp;if&nbsp;tagname&nbsp;is&nbsp;not&nbsp;an&nbsp;alias.<br>
A&nbsp;returned&nbsp;tagroot&nbsp;string&nbsp;must&nbsp;not&nbsp;be&nbsp;modified&nbsp;in&nbsp;any&nbsp;way.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;tagname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;tag&nbsp;name&nbsp;which&nbsp;may&nbsp;be&nbsp;an&nbsp;alias.&nbsp;<br>
tagroot&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;pointer&nbsp;to&nbsp;a&nbsp;returned&nbsp;tag&nbsp;root&nbsp;name.&nbsp;tagroot_in&nbsp;&nbsp;&nbsp;input&nbsp;<br>
tag&nbsp;root&nbsp;name.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-force_new_category"><strong>force_new_category</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;string<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_force_new_category&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char&nbsp;&nbsp;&nbsp;&nbsp;*categoryname);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_force_new_category&nbsp;creates&nbsp;a&nbsp;new&nbsp;category&nbsp;in&nbsp;the&nbsp;current&nbsp;data&nbsp;<br>
block&nbsp;with&nbsp;name&nbsp;categoryname&nbsp;and&nbsp;makes&nbsp;it&nbsp;the&nbsp;current&nbsp;category.&nbsp;<br>
Duplicate&nbsp;category&nbsp;names&nbsp;are&nbsp;allowed.<br>
Even&nbsp;if&nbsp;a&nbsp;category&nbsp;with&nbsp;this&nbsp;name&nbsp;already&nbsp;exists,&nbsp;a&nbsp;new&nbsp;category&nbsp;of&nbsp;<br>
the&nbsp;same&nbsp;name&nbsp;is&nbsp;created&nbsp;and&nbsp;becomes&nbsp;the&nbsp;current&nbsp;category.&nbsp;The&nbsp;allows&nbsp;<br>
for&nbsp;the&nbsp;creation&nbsp;of&nbsp;unlooped&nbsp;tag/value&nbsp;lists&nbsp;drawn&nbsp;from&nbsp;the&nbsp;same&nbsp;<br>
category.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;categoryname&nbsp;&nbsp;&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;new&nbsp;<br>
category.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-force_new_datablock"><strong>force_new_datablock</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;string<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_force_new_datablock&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char&nbsp;&nbsp;&nbsp;&nbsp;*datablockname);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_force_new_datablock&nbsp;creates&nbsp;a&nbsp;new&nbsp;data&nbsp;block&nbsp;with&nbsp;name&nbsp;<br>
datablockname&nbsp;and&nbsp;makes&nbsp;it&nbsp;the&nbsp;current&nbsp;data&nbsp;block.&nbsp;Duplicate&nbsp;data&nbsp;<br>
block&nbsp;names&nbsp;are&nbsp;allowed.&nbsp;cbf_force_new_saveframe&nbsp;creates&nbsp;a&nbsp;new&nbsp;savew&nbsp;<br>
frame&nbsp;with&nbsp;name&nbsp;saveframename&nbsp;and&nbsp;makes&nbsp;it&nbsp;the&nbsp;current&nbsp;save&nbsp;frame.&nbsp;<br>
Duplicate&nbsp;save&nbsp;frame&nbsp;names&nbsp;are&nbsp;allowed.<br>
Even&nbsp;if&nbsp;a&nbsp;save&nbsp;frame&nbsp;with&nbsp;this&nbsp;name&nbsp;already&nbsp;exists,&nbsp;a&nbsp;new&nbsp;save&nbsp;frame&nbsp;<br>
is&nbsp;created&nbsp;and&nbsp;becomes&nbsp;the&nbsp;current&nbsp;save&nbsp;frame.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;datablockname&nbsp;&nbsp;&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;new&nbsp;data&nbsp;<br>
block.&nbsp;saveframename&nbsp;&nbsp;&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;new&nbsp;save&nbsp;frame.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-force_new_saveframe"><strong>force_new_saveframe</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;string<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_force_new_saveframe&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char&nbsp;&nbsp;&nbsp;&nbsp;*saveframename);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_force_new_datablock&nbsp;creates&nbsp;a&nbsp;new&nbsp;data&nbsp;block&nbsp;with&nbsp;name&nbsp;<br>
datablockname&nbsp;and&nbsp;makes&nbsp;it&nbsp;the&nbsp;current&nbsp;data&nbsp;block.&nbsp;Duplicate&nbsp;data&nbsp;<br>
block&nbsp;names&nbsp;are&nbsp;allowed.&nbsp;cbf_force_new_saveframe&nbsp;creates&nbsp;a&nbsp;new&nbsp;savew&nbsp;<br>
frame&nbsp;with&nbsp;name&nbsp;saveframename&nbsp;and&nbsp;makes&nbsp;it&nbsp;the&nbsp;current&nbsp;save&nbsp;frame.&nbsp;<br>
Duplicate&nbsp;save&nbsp;frame&nbsp;names&nbsp;are&nbsp;allowed.<br>
Even&nbsp;if&nbsp;a&nbsp;save&nbsp;frame&nbsp;with&nbsp;this&nbsp;name&nbsp;already&nbsp;exists,&nbsp;a&nbsp;new&nbsp;save&nbsp;frame&nbsp;<br>
is&nbsp;created&nbsp;and&nbsp;becomes&nbsp;the&nbsp;current&nbsp;save&nbsp;frame.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;datablockname&nbsp;&nbsp;&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;new&nbsp;data&nbsp;<br>
block.&nbsp;saveframename&nbsp;&nbsp;&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;new&nbsp;save&nbsp;frame.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_3d_image"><strong>get_3d_image</strong></a>(*args)</dt><dd><tt><a href="#cbf_handle_struct-get_3d_image">get_3d_image</a>(self,&nbsp;void&nbsp;?)</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_3d_image_size"><strong>get_3d_image_size</strong></a>(*args)</dt><dd><tt><a href="#cbf_handle_struct-get_3d_image_size">get_3d_image_size</a>(self,&nbsp;void&nbsp;?)</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_axis_setting"><strong>get_axis_setting</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;Float&nbsp;start,Float&nbsp;increment<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;String&nbsp;axis_id<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_axis_setting&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;reserved,&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char&nbsp;*axis_id,&nbsp;double&nbsp;*start,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;*increment);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_axis_setting&nbsp;sets&nbsp;*start&nbsp;and&nbsp;*increment&nbsp;to&nbsp;the&nbsp;corresponding&nbsp;<br>
values&nbsp;of&nbsp;the&nbsp;axis&nbsp;axis_id.<br>
Either&nbsp;of&nbsp;the&nbsp;destination&nbsp;pointers&nbsp;may&nbsp;be&nbsp;NULL.<br>
The&nbsp;parameter&nbsp;reserved&nbsp;is&nbsp;presently&nbsp;unused&nbsp;and&nbsp;should&nbsp;be&nbsp;set&nbsp;to&nbsp;0.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;reserved&nbsp;&nbsp;&nbsp;&nbsp;Unused.&nbsp;Any&nbsp;value&nbsp;other&nbsp;than&nbsp;0&nbsp;is&nbsp;<br>
invalid.&nbsp;axis_id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Axis&nbsp;id.&nbsp;start&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;<br>
start&nbsp;value.&nbsp;increment&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;increment&nbsp;value.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_bin_sizes"><strong>get_bin_sizes</strong></a>(*args)</dt><dd><tt><a href="#cbf_handle_struct-get_bin_sizes">get_bin_sizes</a>(self,&nbsp;void&nbsp;?)</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_crystal_id"><strong>get_crystal_id</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;string<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_crystal_id&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char&nbsp;**crystal_id);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_crystal_id&nbsp;sets&nbsp;*crystal_id&nbsp;to&nbsp;point&nbsp;to&nbsp;the&nbsp;ASCII&nbsp;value&nbsp;of&nbsp;<br>
the&nbsp;"diffrn.crystal_id"&nbsp;entry.<br>
If&nbsp;the&nbsp;value&nbsp;is&nbsp;not&nbsp;ASCII,&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_BINARY.<br>
The&nbsp;value&nbsp;will&nbsp;be&nbsp;valid&nbsp;as&nbsp;long&nbsp;as&nbsp;the&nbsp;item&nbsp;exists&nbsp;and&nbsp;has&nbsp;not&nbsp;been&nbsp;<br>
set&nbsp;to&nbsp;a&nbsp;new&nbsp;value.<br>
The&nbsp;value&nbsp;must&nbsp;not&nbsp;be&nbsp;modified&nbsp;by&nbsp;the&nbsp;program&nbsp;in&nbsp;any&nbsp;way.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;crystal_id&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;<br>
value&nbsp;pointer.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_datestamp"><strong>get_datestamp</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;int&nbsp;year,int&nbsp;month,int&nbsp;day,int&nbsp;hour,int&nbsp;minute,double&nbsp;second,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;timezone<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_datestamp&nbsp;(cbf_handle&nbsp;handle,&nbsp;unsigned&nbsp;int&nbsp;reserved,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;&nbsp;&nbsp;&nbsp;*year,&nbsp;int&nbsp;*month,&nbsp;int&nbsp;*day,&nbsp;int&nbsp;*hour,&nbsp;int&nbsp;*minute,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;*second,&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;*timezone);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_datestamp&nbsp;sets&nbsp;*year,&nbsp;*month,&nbsp;*day,&nbsp;*hour,&nbsp;*minute&nbsp;and&nbsp;<br>
*second&nbsp;to&nbsp;the&nbsp;corresponding&nbsp;values&nbsp;of&nbsp;the&nbsp;collection&nbsp;timestamp.&nbsp;<br>
*timezone&nbsp;is&nbsp;set&nbsp;to&nbsp;timezone&nbsp;difference&nbsp;from&nbsp;UTC&nbsp;in&nbsp;minutes.&nbsp;The&nbsp;<br>
parameter&nbsp;&lt;&nbsp;i&gt;reserved&nbsp;is&nbsp;presently&nbsp;unused&nbsp;and&nbsp;should&nbsp;be&nbsp;set&nbsp;to&nbsp;0.<br>
Any&nbsp;of&nbsp;the&nbsp;destination&nbsp;pointers&nbsp;may&nbsp;be&nbsp;NULL.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;reserved&nbsp;&nbsp;&nbsp;Unused.&nbsp;Any&nbsp;value&nbsp;other&nbsp;than&nbsp;0&nbsp;is&nbsp;<br>
invalid.&nbsp;year&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;timestamp&nbsp;year.&nbsp;month&nbsp;&nbsp;&nbsp;<br>
Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;timestamp&nbsp;month&nbsp;(1-12).&nbsp;day&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;<br>
the&nbsp;destination&nbsp;timestamp&nbsp;day&nbsp;(1-31).&nbsp;hour&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;<br>
destination&nbsp;timestamp&nbsp;hour&nbsp;(0-23).&nbsp;minute&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;<br>
destination&nbsp;timestamp&nbsp;minute&nbsp;(0-59).&nbsp;second&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;<br>
destination&nbsp;timestamp&nbsp;second&nbsp;(0-60.0).&nbsp;timezone&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;<br>
destination&nbsp;timezone&nbsp;difference&nbsp;from&nbsp;UTC&nbsp;in&nbsp;minutes.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_dictionary"><strong>get_dictionary</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;CBFHandle&nbsp;dictionary<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_dictionary&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;cbf_handle&nbsp;*&nbsp;dictionary);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_dictionary&nbsp;sets&nbsp;*dictionary&nbsp;to&nbsp;the&nbsp;handle&nbsp;of&nbsp;a&nbsp;CBF&nbsp;which&nbsp;has&nbsp;<br>
been&nbsp;associated&nbsp;with&nbsp;the&nbsp;CBF&nbsp;handle&nbsp;by&nbsp;cbf_set_dictionary.&nbsp;<br>
cbf_set_dictionary&nbsp;associates&nbsp;the&nbsp;CBF&nbsp;handle&nbsp;dictionary_in&nbsp;with&nbsp;<br>
handle&nbsp;as&nbsp;its&nbsp;dictionary.&nbsp;cbf_require_dictionary&nbsp;sets&nbsp;*dictionary&nbsp;to&nbsp;<br>
the&nbsp;handle&nbsp;of&nbsp;a&nbsp;CBF&nbsp;which&nbsp;has&nbsp;been&nbsp;associated&nbsp;with&nbsp;the&nbsp;CBF&nbsp;handle&nbsp;by&nbsp;<br>
cbf_set_dictionary&nbsp;or&nbsp;creates&nbsp;a&nbsp;new&nbsp;empty&nbsp;CBF&nbsp;and&nbsp;associates&nbsp;it&nbsp;with&nbsp;<br>
handle,&nbsp;returning&nbsp;the&nbsp;new&nbsp;handle&nbsp;in&nbsp;*dictionary.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;dictionary&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;CBF&nbsp;handle&nbsp;of&nbsp;<br>
dictionary.&nbsp;dictionary_in&nbsp;&nbsp;&nbsp;CBF&nbsp;handle&nbsp;of&nbsp;dcitionary.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_diffrn_id"><strong>get_diffrn_id</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;string<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_diffrn_id&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char&nbsp;**diffrn_id);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_diffrn_id&nbsp;sets&nbsp;*diffrn_id&nbsp;to&nbsp;point&nbsp;to&nbsp;the&nbsp;ASCII&nbsp;value&nbsp;of&nbsp;the&nbsp;<br>
"diffrn.id"&nbsp;entry.&nbsp;cbf_require_diffrn_id&nbsp;also&nbsp;sets&nbsp;*diffrn_id&nbsp;to&nbsp;<br>
point&nbsp;to&nbsp;the&nbsp;ASCII&nbsp;value&nbsp;of&nbsp;the&nbsp;"diffrn.id"&nbsp;entry,&nbsp;but,&nbsp;if&nbsp;the&nbsp;<br>
"diffrn.id"&nbsp;entry&nbsp;does&nbsp;not&nbsp;exist,&nbsp;it&nbsp;sets&nbsp;the&nbsp;value&nbsp;in&nbsp;the&nbsp;CBF&nbsp;and&nbsp;<br>
in*diffrn_id&nbsp;to&nbsp;the&nbsp;character&nbsp;string&nbsp;given&nbsp;by&nbsp;default_id,&nbsp;creating&nbsp;<br>
the&nbsp;category&nbsp;and&nbsp;column&nbsp;is&nbsp;necessary.<br>
The&nbsp;diffrn_id&nbsp;will&nbsp;be&nbsp;valid&nbsp;as&nbsp;long&nbsp;as&nbsp;the&nbsp;item&nbsp;exists&nbsp;and&nbsp;has&nbsp;not&nbsp;<br>
been&nbsp;set&nbsp;to&nbsp;a&nbsp;new&nbsp;value.<br>
The&nbsp;diffrn_id&nbsp;must&nbsp;not&nbsp;be&nbsp;modified&nbsp;by&nbsp;the&nbsp;program&nbsp;in&nbsp;any&nbsp;way.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;diffrn_id&nbsp;&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;<br>
value&nbsp;pointer.&nbsp;default_id&nbsp;&nbsp;&nbsp;Character&nbsp;string&nbsp;default&nbsp;value.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_divergence"><strong>get_divergence</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;Float&nbsp;div_x_source,Float&nbsp;div_y_source,Float&nbsp;div_x_y_source<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_divergence&nbsp;(cbf_handle&nbsp;handle,&nbsp;double&nbsp;*div_x_source,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;*div_y_source,&nbsp;double&nbsp;*div_x_y_source);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_divergence&nbsp;sets&nbsp;*div_x_source,&nbsp;*div_y_source&nbsp;and&nbsp;<br>
*div_x_y_source&nbsp;to&nbsp;the&nbsp;corresponding&nbsp;source&nbsp;divergence&nbsp;parameters.<br>
Any&nbsp;of&nbsp;the&nbsp;destination&nbsp;pointers&nbsp;may&nbsp;be&nbsp;NULL.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;div_x_source&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;<br>
destination&nbsp;div_x_source.&nbsp;div_y_source&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;<br>
div_y_source.&nbsp;div_x_y_source&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;<br>
div_x_y_source.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_doublevalue"><strong>get_doublevalue</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;double<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_doublevalue&nbsp;(cbf_handle&nbsp;handle,&nbsp;double&nbsp;*number);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_doublevalue&nbsp;sets&nbsp;*number&nbsp;to&nbsp;the&nbsp;value&nbsp;of&nbsp;the&nbsp;ASCII&nbsp;item&nbsp;at&nbsp;<br>
the&nbsp;current&nbsp;column&nbsp;and&nbsp;row&nbsp;interpreted&nbsp;as&nbsp;a&nbsp;decimal&nbsp;floating-point&nbsp;<br>
number.&nbsp;cbf_require_doublevalue&nbsp;sets&nbsp;*number&nbsp;to&nbsp;the&nbsp;value&nbsp;of&nbsp;the&nbsp;<br>
ASCII&nbsp;item&nbsp;at&nbsp;the&nbsp;current&nbsp;column&nbsp;and&nbsp;row&nbsp;interpreted&nbsp;as&nbsp;a&nbsp;decimal&nbsp;<br>
floating-point&nbsp;number,&nbsp;setting&nbsp;it&nbsp;to&nbsp;defaultvalue&nbsp;if&nbsp;necessary.<br>
If&nbsp;the&nbsp;value&nbsp;is&nbsp;not&nbsp;ASCII,&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_BINARY.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;number&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;<br>
number.&nbsp;defaultvalue&nbsp;&nbsp;&nbsp;default&nbsp;number&nbsp;value.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_element_id"><strong>get_element_id</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;String<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;Integer&nbsp;element_number<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_element_id&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;&nbsp;&nbsp;&nbsp;element_number,&nbsp;const&nbsp;char&nbsp;**element_id);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_element_id&nbsp;sets&nbsp;*element_id&nbsp;to&nbsp;point&nbsp;to&nbsp;the&nbsp;ASCII&nbsp;value&nbsp;of&nbsp;<br>
the&nbsp;element_number&nbsp;th&nbsp;"diffrn_data_frame.detector_element_id"&nbsp;<br>
entry,&nbsp;counting&nbsp;from&nbsp;0.<br>
If&nbsp;the&nbsp;detector&nbsp;element&nbsp;does&nbsp;not&nbsp;exist,&nbsp;the&nbsp;function&nbsp;returns&nbsp;<br>
CBF_NOTFOUND.<br>
The&nbsp;element_id&nbsp;will&nbsp;be&nbsp;valid&nbsp;as&nbsp;long&nbsp;as&nbsp;the&nbsp;item&nbsp;exists&nbsp;and&nbsp;has&nbsp;not&nbsp;<br>
been&nbsp;set&nbsp;to&nbsp;a&nbsp;new&nbsp;value.<br>
The&nbsp;element_id&nbsp;must&nbsp;not&nbsp;be&nbsp;modified&nbsp;by&nbsp;the&nbsp;program&nbsp;in&nbsp;any&nbsp;way.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;element_number&nbsp;&nbsp;&nbsp;The&nbsp;number&nbsp;of&nbsp;the&nbsp;detector&nbsp;<br>
element&nbsp;counting&nbsp;from&nbsp;0&nbsp;by&nbsp;order&nbsp;of&nbsp;appearance&nbsp;in&nbsp;the&nbsp;<br>
"diffrn_data_frame"&nbsp;category.&nbsp;element_id&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;<br>
destination.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_gain"><strong>get_gain</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;Float&nbsp;gain,Float&nbsp;gain_esd<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_gain&nbsp;(cbf_handle&nbsp;handle,&nbsp;unsigned&nbsp;int&nbsp;element_number,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;*gain,&nbsp;double&nbsp;*gain_esd);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_gain&nbsp;sets&nbsp;*gain&nbsp;and&nbsp;*gain_esd&nbsp;to&nbsp;the&nbsp;corresponding&nbsp;gain&nbsp;<br>
parameters&nbsp;for&nbsp;element&nbsp;number&nbsp;element_number.<br>
Either&nbsp;of&nbsp;the&nbsp;destination&nbsp;pointers&nbsp;may&nbsp;be&nbsp;NULL.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;element_number&nbsp;&nbsp;&nbsp;The&nbsp;number&nbsp;of&nbsp;the&nbsp;detector&nbsp;<br>
element&nbsp;counting&nbsp;from&nbsp;0&nbsp;by&nbsp;order&nbsp;of&nbsp;appearance&nbsp;in&nbsp;the&nbsp;<br>
"diffrn_data_frame"&nbsp;category.&nbsp;gain&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;<br>
gain.&nbsp;gain_esd&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;gain_esd.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_image"><strong>get_image</strong></a>(*args)</dt><dd><tt><a href="#cbf_handle_struct-get_image">get_image</a>(self,&nbsp;void&nbsp;?)</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_image_size"><strong>get_image_size</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;size_t&nbsp;ndim1,size_t&nbsp;ndim2<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;Integer&nbsp;element_number<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_image_size&nbsp;(cbf_handle&nbsp;handle,&nbsp;unsigned&nbsp;int&nbsp;reserved,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;element_number,&nbsp;size_t&nbsp;*ndim1,&nbsp;size_t&nbsp;*ndim2);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_image_size&nbsp;sets&nbsp;*ndim1&nbsp;and&nbsp;*ndim2&nbsp;to&nbsp;the&nbsp;slow&nbsp;and&nbsp;fast&nbsp;<br>
dimensions&nbsp;of&nbsp;the&nbsp;image&nbsp;array&nbsp;for&nbsp;element&nbsp;number&nbsp;element_number.&nbsp;If&nbsp;<br>
the&nbsp;array&nbsp;is&nbsp;1-dimensional,&nbsp;*ndim1&nbsp;will&nbsp;be&nbsp;set&nbsp;to&nbsp;the&nbsp;array&nbsp;size&nbsp;and&nbsp;<br>
*ndim2&nbsp;will&nbsp;be&nbsp;set&nbsp;to&nbsp;1.&nbsp;If&nbsp;the&nbsp;array&nbsp;is&nbsp;3-dimensional&nbsp;an&nbsp;error&nbsp;code&nbsp;<br>
will&nbsp;be&nbsp;returned.&nbsp;cbf_get_3d_image_size&nbsp;sets&nbsp;*ndim1,&nbsp;*ndim2&nbsp;and&nbsp;<br>
*ndim3&nbsp;to&nbsp;the&nbsp;slowest,&nbsp;next&nbsp;fastest&nbsp;and&nbsp;fastest&nbsp;dimensions,&nbsp;<br>
respectively,&nbsp;of&nbsp;the&nbsp;3D&nbsp;image&nbsp;array&nbsp;for&nbsp;element&nbsp;number&nbsp;<br>
element_number.&nbsp;If&nbsp;the&nbsp;array&nbsp;is&nbsp;1-dimensional,&nbsp;*ndim1&nbsp;will&nbsp;be&nbsp;set&nbsp;to&nbsp;<br>
the&nbsp;array&nbsp;size&nbsp;and&nbsp;*ndim2&nbsp;and</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_integerarray_as_string"><strong>get_integerarray_as_string</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;(Binary)String<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_integerarray&nbsp;(cbf_handle&nbsp;handle,&nbsp;int&nbsp;*binary_id,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;void&nbsp;&nbsp;&nbsp;&nbsp;*array,&nbsp;size_t&nbsp;elsize,&nbsp;int&nbsp;elsigned,&nbsp;size_t&nbsp;elements,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;size_t&nbsp;&nbsp;&nbsp;&nbsp;*elements_read);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_integerarray&nbsp;reads&nbsp;the&nbsp;binary&nbsp;value&nbsp;of&nbsp;the&nbsp;item&nbsp;at&nbsp;the&nbsp;<br>
current&nbsp;column&nbsp;and&nbsp;row&nbsp;into&nbsp;an&nbsp;integer&nbsp;array.&nbsp;The&nbsp;array&nbsp;consists&nbsp;of&nbsp;<br>
elements&nbsp;elements&nbsp;of&nbsp;elsize&nbsp;bytes&nbsp;each,&nbsp;starting&nbsp;at&nbsp;array.&nbsp;The&nbsp;<br>
elements&nbsp;are&nbsp;signed&nbsp;if&nbsp;elsigned&nbsp;is&nbsp;non-0&nbsp;and&nbsp;unsigned&nbsp;otherwise.&nbsp;<br>
*binary_id&nbsp;is&nbsp;set&nbsp;to&nbsp;the&nbsp;binary&nbsp;section&nbsp;identifier&nbsp;and&nbsp;*elements_read&nbsp;<br>
to&nbsp;the&nbsp;number&nbsp;of&nbsp;elements&nbsp;actually&nbsp;read.&nbsp;cbf_get_realarray&nbsp;reads&nbsp;the&nbsp;<br>
binary&nbsp;value&nbsp;of&nbsp;the&nbsp;item&nbsp;at&nbsp;the&nbsp;current&nbsp;column&nbsp;and&nbsp;row&nbsp;into&nbsp;a&nbsp;real&nbsp;<br>
array.&nbsp;The&nbsp;array&nbsp;consists&nbsp;of&nbsp;elements&nbsp;elements&nbsp;of&nbsp;elsize&nbsp;bytes&nbsp;each,&nbsp;<br>
starting&nbsp;at&nbsp;array.&nbsp;*binary_id&nbsp;is&nbsp;set&nbsp;to&nbsp;the&nbsp;binary&nbsp;section&nbsp;identifier&nbsp;<br>
and&nbsp;*elements_read&nbsp;to&nbsp;the&nbsp;number&nbsp;of&nbsp;elements&nbsp;actually&nbsp;read.<br>
If&nbsp;any&nbsp;element&nbsp;in&nbsp;the&nbsp;integer&nbsp;binary&nbsp;data&nbsp;cant&nbsp;fit&nbsp;into&nbsp;the&nbsp;<br>
destination&nbsp;element,&nbsp;the&nbsp;destination&nbsp;is&nbsp;set&nbsp;the&nbsp;nearest&nbsp;possible&nbsp;<br>
value.<br>
If&nbsp;the&nbsp;value&nbsp;is&nbsp;not&nbsp;binary,&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_ASCII.<br>
If&nbsp;the&nbsp;requested&nbsp;number&nbsp;of&nbsp;elements&nbsp;cant&nbsp;be&nbsp;read,&nbsp;the&nbsp;function&nbsp;will&nbsp;<br>
read&nbsp;as&nbsp;many&nbsp;as&nbsp;it&nbsp;can&nbsp;and&nbsp;then&nbsp;return&nbsp;CBF_ENDOFDATA.<br>
Currently,&nbsp;the&nbsp;destination&nbsp;array&nbsp;must&nbsp;consist&nbsp;of&nbsp;chars,&nbsp;shorts&nbsp;or&nbsp;<br>
ints&nbsp;(signed&nbsp;or&nbsp;unsigned).&nbsp;If&nbsp;elsize&nbsp;is&nbsp;not&nbsp;equal&nbsp;to&nbsp;sizeof&nbsp;(char),&nbsp;<br>
sizeof&nbsp;(short)&nbsp;or&nbsp;sizeof&nbsp;(int),&nbsp;for&nbsp;cbf_get_integerarray,&nbsp;or&nbsp;<br>
sizeof(double)&nbsp;or&nbsp;sizeof(float),&nbsp;for&nbsp;cbf_get_realarray&nbsp;the&nbsp;function&nbsp;<br>
returns&nbsp;CBF_ARGUMENT.<br>
An&nbsp;additional&nbsp;restriction&nbsp;in&nbsp;the&nbsp;current&nbsp;version&nbsp;of&nbsp;CBFlib&nbsp;is&nbsp;that&nbsp;<br>
values&nbsp;too&nbsp;large&nbsp;to&nbsp;fit&nbsp;in&nbsp;an&nbsp;int&nbsp;are&nbsp;not&nbsp;correctly&nbsp;decompressed.&nbsp;As&nbsp;<br>
an&nbsp;example,&nbsp;if&nbsp;the&nbsp;machine&nbsp;with&nbsp;32-bit&nbsp;ints&nbsp;is&nbsp;reading&nbsp;an&nbsp;array&nbsp;<br>
containing&nbsp;a&nbsp;value&nbsp;outside&nbsp;the&nbsp;range&nbsp;0&nbsp;..&nbsp;2^32-1&nbsp;(unsigned)&nbsp;or&nbsp;-2^31&nbsp;<br>
..&nbsp;2^31-1&nbsp;(signed),&nbsp;the&nbsp;array&nbsp;will&nbsp;not&nbsp;be&nbsp;correctly&nbsp;decompressed.&nbsp;<br>
This&nbsp;restriction&nbsp;will&nbsp;be&nbsp;removed&nbsp;in&nbsp;a&nbsp;future&nbsp;release.&nbsp;For&nbsp;<br>
cbf_get_realarray,&nbsp;only&nbsp;IEEE&nbsp;format&nbsp;is&nbsp;supported.&nbsp;No&nbsp;conversion&nbsp;to&nbsp;<br>
other&nbsp;floating&nbsp;point&nbsp;formats&nbsp;is&nbsp;done&nbsp;at&nbsp;this&nbsp;time.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;binary_id&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;integer&nbsp;<br>
binary&nbsp;identifier.&nbsp;array&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;array.&nbsp;elsize&nbsp;&nbsp;&nbsp;<br>
Size&nbsp;in&nbsp;bytes&nbsp;of&nbsp;each&nbsp;destination&nbsp;array&nbsp;element.&nbsp;elsigned&nbsp;&nbsp;&nbsp;Set&nbsp;to&nbsp;<br>
non-0&nbsp;if&nbsp;the&nbsp;destination&nbsp;array&nbsp;elements&nbsp;are&nbsp;signed.&nbsp;elements&nbsp;&nbsp;&nbsp;The&nbsp;<br>
number&nbsp;of&nbsp;elements&nbsp;to&nbsp;read.&nbsp;elements_read&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;<br>
destination&nbsp;number&nbsp;of&nbsp;elements&nbsp;actually&nbsp;read.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_integerarrayparameters"><strong>get_integerarrayparameters</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;int&nbsp;compression,int&nbsp;binary_id,int&nbsp;elsize,int&nbsp;elsigned,int&nbsp;elunsigned,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;elements,int&nbsp;minelement,int&nbsp;maxelement<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_integerarrayparameters&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;&nbsp;&nbsp;&nbsp;*compression,&nbsp;int&nbsp;*binary_id,&nbsp;size_t&nbsp;*elsize,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;*elsigned,&nbsp;int&nbsp;&nbsp;&nbsp;&nbsp;*elunsigned,&nbsp;size_t&nbsp;*elements,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;*minelement,&nbsp;int&nbsp;*maxelement);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_integerarrayparameters&nbsp;sets&nbsp;*compression,&nbsp;*binary_id,&nbsp;<br>
*elsize,&nbsp;*elsigned,&nbsp;*elunsigned,&nbsp;*elements,&nbsp;*minelement&nbsp;and&nbsp;<br>
*maxelement&nbsp;to&nbsp;values&nbsp;read&nbsp;from&nbsp;the&nbsp;binary&nbsp;value&nbsp;of&nbsp;the&nbsp;item&nbsp;at&nbsp;the&nbsp;<br>
current&nbsp;column&nbsp;and&nbsp;row.&nbsp;This&nbsp;provides&nbsp;all&nbsp;the&nbsp;arguments&nbsp;needed&nbsp;for&nbsp;a&nbsp;<br>
subsequent&nbsp;call&nbsp;to&nbsp;cbf_set_integerarray,&nbsp;if&nbsp;a&nbsp;copy&nbsp;of&nbsp;the&nbsp;array&nbsp;is&nbsp;to&nbsp;<br>
be&nbsp;made&nbsp;into&nbsp;another&nbsp;CIF&nbsp;or&nbsp;CBF.&nbsp;cbf_get_realarrayparameters&nbsp;sets&nbsp;<br>
*compression,&nbsp;*binary_id,&nbsp;*elsize,&nbsp;*elements&nbsp;to&nbsp;values&nbsp;read&nbsp;from&nbsp;the&nbsp;<br>
binary&nbsp;value&nbsp;of&nbsp;the&nbsp;item&nbsp;at&nbsp;the&nbsp;current&nbsp;column&nbsp;and&nbsp;row.&nbsp;This&nbsp;provides&nbsp;<br>
all&nbsp;the&nbsp;arguments&nbsp;needed&nbsp;for&nbsp;a&nbsp;subsequent&nbsp;call&nbsp;to&nbsp;cbf_set_realarray,&nbsp;<br>
if&nbsp;a&nbsp;copy&nbsp;of&nbsp;the&nbsp;arry&nbsp;is&nbsp;to&nbsp;be&nbsp;made&nbsp;into&nbsp;another&nbsp;CIF&nbsp;or&nbsp;CBF.<br>
The&nbsp;variants&nbsp;cbf_get_integerarrayparameters_wdims&nbsp;and&nbsp;<br>
cbf_get_realarrayparameters_wdims&nbsp;set&nbsp;**byteorder,&nbsp;*dim1,&nbsp;*dim2,&nbsp;<br>
*dim3,&nbsp;and&nbsp;*padding&nbsp;as&nbsp;well,&nbsp;providing&nbsp;the&nbsp;additional&nbsp;parameters&nbsp;<br>
needed&nbsp;for&nbsp;a&nbsp;subsequent&nbsp;call&nbsp;to&nbsp;cbf_set_integerarray_wdims&nbsp;or&nbsp;<br>
cbf_set_realarray_wdims.<br>
The&nbsp;value&nbsp;returned&nbsp;in&nbsp;*byteorder&nbsp;is&nbsp;a&nbsp;pointer&nbsp;either&nbsp;to&nbsp;the&nbsp;string&nbsp;<br>
"little_endian"&nbsp;or&nbsp;to&nbsp;the&nbsp;string&nbsp;"big_endian".&nbsp;This&nbsp;should&nbsp;be&nbsp;the&nbsp;<br>
byte&nbsp;order&nbsp;of&nbsp;the&nbsp;data,&nbsp;not&nbsp;necessarily&nbsp;of&nbsp;the&nbsp;host&nbsp;machine.&nbsp;No&nbsp;<br>
attempt&nbsp;should&nbsp;be&nbsp;made&nbsp;to&nbsp;modify&nbsp;this&nbsp;string.&nbsp;At&nbsp;this&nbsp;time&nbsp;only&nbsp;<br>
"little_endian"&nbsp;will&nbsp;be&nbsp;returned.<br>
The&nbsp;values&nbsp;returned&nbsp;in&nbsp;*dim1,&nbsp;*dim2&nbsp;and&nbsp;*dim3&nbsp;are&nbsp;the&nbsp;sizes&nbsp;of&nbsp;the&nbsp;<br>
fastest&nbsp;changing,&nbsp;second&nbsp;fastest&nbsp;changing&nbsp;and&nbsp;third&nbsp;fastest&nbsp;changing&nbsp;<br>
dimensions&nbsp;of&nbsp;the&nbsp;array,&nbsp;if&nbsp;specified,&nbsp;or&nbsp;zero,&nbsp;if&nbsp;not&nbsp;specified.<br>
The&nbsp;value&nbsp;returned&nbsp;in&nbsp;*padding&nbsp;is&nbsp;the&nbsp;size&nbsp;of&nbsp;the&nbsp;post-data&nbsp;padding,&nbsp;<br>
if&nbsp;any&nbsp;and&nbsp;if&nbsp;specified&nbsp;in&nbsp;the&nbsp;data&nbsp;header.&nbsp;The&nbsp;value&nbsp;is&nbsp;given&nbsp;as&nbsp;a&nbsp;<br>
count&nbsp;of&nbsp;octets.<br>
If&nbsp;the&nbsp;value&nbsp;is&nbsp;not&nbsp;binary,&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_ASCII.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;compression&nbsp;&nbsp;&nbsp;Compression&nbsp;method&nbsp;used.&nbsp;elsize&nbsp;&nbsp;&nbsp;<br>
Size&nbsp;in&nbsp;bytes&nbsp;of&nbsp;each&nbsp;array&nbsp;element.&nbsp;binary_id&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;<br>
destination&nbsp;integer&nbsp;binary&nbsp;identifier.&nbsp;elsigned&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;an&nbsp;<br>
integer.&nbsp;Set&nbsp;to&nbsp;1&nbsp;if&nbsp;the&nbsp;elements&nbsp;can&nbsp;be&nbsp;read&nbsp;as&nbsp;signed&nbsp;integers.&nbsp;<br>
elunsigned&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;an&nbsp;integer.&nbsp;Set&nbsp;to&nbsp;1&nbsp;if&nbsp;the&nbsp;elements&nbsp;can&nbsp;be&nbsp;<br>
read&nbsp;as&nbsp;unsigned&nbsp;integers.&nbsp;elements&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;<br>
number&nbsp;of&nbsp;elements.&nbsp;minelement&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;smallest&nbsp;<br>
element.&nbsp;maxelement&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;largest&nbsp;element.&nbsp;<br>
byteorder&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;byte&nbsp;order.&nbsp;dim1&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;<br>
the&nbsp;destination&nbsp;fastest&nbsp;dimension.&nbsp;dim2&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;<br>
second&nbsp;fastest&nbsp;dimension.&nbsp;dim3&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;third&nbsp;<br>
fastest&nbsp;dimension.&nbsp;padding&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;padding&nbsp;size.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_integerarrayparameters_wdims"><strong>get_integerarrayparameters_wdims</strong></a>(*args)</dt><dd><tt><a href="#cbf_handle_struct-get_integerarrayparameters_wdims">get_integerarrayparameters_wdims</a>(self,&nbsp;void&nbsp;?)</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_integervalue"><strong>get_integervalue</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;int<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_integervalue&nbsp;(cbf_handle&nbsp;handle,&nbsp;int&nbsp;*number);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_integervalue&nbsp;sets&nbsp;*number&nbsp;to&nbsp;the&nbsp;value&nbsp;of&nbsp;the&nbsp;ASCII&nbsp;item&nbsp;at&nbsp;<br>
the&nbsp;current&nbsp;column&nbsp;and&nbsp;row&nbsp;interpreted&nbsp;as&nbsp;a&nbsp;decimal&nbsp;integer.&nbsp;<br>
cbf_require_integervalue&nbsp;sets&nbsp;*number&nbsp;to&nbsp;the&nbsp;value&nbsp;of&nbsp;the&nbsp;ASCII&nbsp;item&nbsp;<br>
at&nbsp;the&nbsp;current&nbsp;column&nbsp;and&nbsp;row&nbsp;interpreted&nbsp;as&nbsp;a&nbsp;decimal&nbsp;integer,&nbsp;<br>
setting&nbsp;it&nbsp;to&nbsp;defaultvalue&nbsp;if&nbsp;necessary.<br>
If&nbsp;the&nbsp;value&nbsp;is&nbsp;not&nbsp;ASCII,&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_BINARY.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;number&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;pointer&nbsp;to&nbsp;the&nbsp;number.&nbsp;<br>
defaultvalue&nbsp;&nbsp;&nbsp;default&nbsp;number&nbsp;value.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_integration_time"><strong>get_integration_time</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;Float&nbsp;time<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_integration_time&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;&nbsp;&nbsp;&nbsp;reserved,&nbsp;double&nbsp;*time);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_integration_time&nbsp;sets&nbsp;*time&nbsp;to&nbsp;the&nbsp;integration&nbsp;time&nbsp;in&nbsp;<br>
seconds.&nbsp;The&nbsp;parameter&nbsp;reserved&nbsp;is&nbsp;presently&nbsp;unused&nbsp;and&nbsp;should&nbsp;be&nbsp;set&nbsp;<br>
to&nbsp;0.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;reserved&nbsp;&nbsp;&nbsp;Unused.&nbsp;Any&nbsp;value&nbsp;other&nbsp;than&nbsp;0&nbsp;is&nbsp;<br>
invalid.&nbsp;time&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;time.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_orientation_matrix"><strong>get_orientation_matrix</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;Float&nbsp;matrix_0,Float&nbsp;matrix_1,Float&nbsp;matrix_2,Float&nbsp;matrix_3,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Float&nbsp;matrix_4,Float&nbsp;matrix_5,Float&nbsp;matrix_6,Float&nbsp;matrix_7,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Float&nbsp;matrix_8<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_orientation_matrix&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;&nbsp;&nbsp;&nbsp;ub_matrix[9]);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_orientation_matrix&nbsp;sets&nbsp;ub_matrix&nbsp;to&nbsp;point&nbsp;to&nbsp;the&nbsp;array&nbsp;of&nbsp;<br>
orientation&nbsp;matrix&nbsp;entries&nbsp;in&nbsp;the&nbsp;"diffrn"&nbsp;category&nbsp;in&nbsp;the&nbsp;order&nbsp;of&nbsp;<br>
columns:<br>
"UB[1][1]"&nbsp;"UB[1][2]"&nbsp;"UB[1][3]"&nbsp;"UB[2][1]"&nbsp;"UB[2][2]"&nbsp;<br>
"UB[2][3]"&nbsp;"UB[3][1]"&nbsp;"UB[3][2]"&nbsp;"UB[3][3]"<br>
cbf_set_orientation_matrix&nbsp;sets&nbsp;the&nbsp;values&nbsp;in&nbsp;the&nbsp;"diffrn"&nbsp;category&nbsp;<br>
to&nbsp;the&nbsp;values&nbsp;pointed&nbsp;to&nbsp;by&nbsp;ub_matrix.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;ubmatric&nbsp;&nbsp;&nbsp;Source&nbsp;or&nbsp;destination&nbsp;array&nbsp;of&nbsp;9&nbsp;<br>
doubles&nbsp;giving&nbsp;the&nbsp;orientation&nbsp;matrix&nbsp;parameters.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_overload"><strong>get_overload</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;Float&nbsp;overload<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;Integer&nbsp;element_number<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_overload&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;element_number,&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;*overload);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_overload&nbsp;sets&nbsp;*overload&nbsp;to&nbsp;the&nbsp;overload&nbsp;value&nbsp;for&nbsp;element&nbsp;<br>
number&nbsp;element_number.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;element_number&nbsp;&nbsp;&nbsp;The&nbsp;number&nbsp;of&nbsp;the&nbsp;detector&nbsp;<br>
element&nbsp;counting&nbsp;from&nbsp;0&nbsp;by&nbsp;order&nbsp;of&nbsp;appearance&nbsp;in&nbsp;the&nbsp;<br>
"diffrn_data_frame"&nbsp;category.&nbsp;overload&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;<br>
overload.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_pixel_size"><strong>get_pixel_size</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;Float&nbsp;pixel_size<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;Int&nbsp;element_number,Int&nbsp;axis_number<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_pixel_size&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;&nbsp;&nbsp;&nbsp;element_number,&nbsp;unsigned&nbsp;int&nbsp;axis_number,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;*psize);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_pixel_size&nbsp;sets&nbsp;*psize&nbsp;to&nbsp;point&nbsp;to&nbsp;the&nbsp;double&nbsp;value&nbsp;in&nbsp;<br>
millimeters&nbsp;of&nbsp;the&nbsp;axis&nbsp;axis_number&nbsp;of&nbsp;the&nbsp;detector&nbsp;element&nbsp;<br>
element_number.&nbsp;The&nbsp;axis_number&nbsp;is&nbsp;numbered&nbsp;from&nbsp;1,&nbsp;starting&nbsp;with&nbsp;the&nbsp;<br>
fastest&nbsp;axis.<br>
If&nbsp;the&nbsp;pixel&nbsp;size&nbsp;is&nbsp;not&nbsp;given&nbsp;explcitly&nbsp;in&nbsp;the&nbsp;<br>
"array_element_size"&nbsp;category,&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_NOTFOUND.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;element_number&nbsp;&nbsp;&nbsp;The&nbsp;number&nbsp;of&nbsp;the&nbsp;detector&nbsp;<br>
element&nbsp;counting&nbsp;from&nbsp;0&nbsp;by&nbsp;order&nbsp;of&nbsp;appearance&nbsp;in&nbsp;the&nbsp;<br>
"diffrn_data_frame"&nbsp;category.&nbsp;axis_number&nbsp;&nbsp;&nbsp;The&nbsp;number&nbsp;of&nbsp;the&nbsp;axis,&nbsp;<br>
fastest&nbsp;first,&nbsp;starting&nbsp;from&nbsp;1.</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_polarization"><strong>get_polarization</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;float&nbsp;polarizn_source_ratio,float&nbsp;polarizn_source_norm<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_polarization&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;&nbsp;&nbsp;&nbsp;*polarizn_source_ratio,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;*polarizn_source_norm);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_polarization&nbsp;sets&nbsp;*polarizn_source_ratio&nbsp;and&nbsp;<br>
*polarizn_source_norm&nbsp;to&nbsp;the&nbsp;corresponding&nbsp;source&nbsp;polarization&nbsp;<br>
parameters.<br>
Either&nbsp;destination&nbsp;pointer&nbsp;may&nbsp;be&nbsp;NULL.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;polarizn_source_ratio&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;<br>
destination&nbsp;polarizn_source_ratio.&nbsp;polarizn_source_norm&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;<br>
the&nbsp;destination&nbsp;polarizn_source_norm.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_real_3d_image"><strong>get_real_3d_image</strong></a>(*args)</dt><dd><tt><a href="#cbf_handle_struct-get_real_3d_image">get_real_3d_image</a>(self,&nbsp;void&nbsp;?)</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_real_image"><strong>get_real_image</strong></a>(*args)</dt><dd><tt><a href="#cbf_handle_struct-get_real_image">get_real_image</a>(self,&nbsp;void&nbsp;?)</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_realarray"><strong>get_realarray</strong></a>(*args)</dt><dd><tt><a href="#cbf_handle_struct-get_realarray">get_realarray</a>(self,&nbsp;void&nbsp;?)</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_realarrayparameters"><strong>get_realarrayparameters</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;int&nbsp;compression,int&nbsp;binary_id,int&nbsp;elsize,int&nbsp;elements<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_realarrayparameters&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;&nbsp;&nbsp;&nbsp;*compression,&nbsp;int&nbsp;*binary_id,&nbsp;size_t&nbsp;*elsize,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;size_t&nbsp;*elements);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_integerarrayparameters&nbsp;sets&nbsp;*compression,&nbsp;*binary_id,&nbsp;<br>
*elsize,&nbsp;*elsigned,&nbsp;*elunsigned,&nbsp;*elements,&nbsp;*minelement&nbsp;and&nbsp;<br>
*maxelement&nbsp;to&nbsp;values&nbsp;read&nbsp;from&nbsp;the&nbsp;binary&nbsp;value&nbsp;of&nbsp;the&nbsp;item&nbsp;at&nbsp;the&nbsp;<br>
current&nbsp;column&nbsp;and&nbsp;row.&nbsp;This&nbsp;provides&nbsp;all&nbsp;the&nbsp;arguments&nbsp;needed&nbsp;for&nbsp;a&nbsp;<br>
subsequent&nbsp;call&nbsp;to&nbsp;cbf_set_integerarray,&nbsp;if&nbsp;a&nbsp;copy&nbsp;of&nbsp;the&nbsp;array&nbsp;is&nbsp;to&nbsp;<br>
be&nbsp;made&nbsp;into&nbsp;another&nbsp;CIF&nbsp;or&nbsp;CBF.&nbsp;cbf_get_realarrayparameters&nbsp;sets&nbsp;<br>
*compression,&nbsp;*binary_id,&nbsp;*elsize,&nbsp;*elements&nbsp;to&nbsp;values&nbsp;read&nbsp;from&nbsp;the&nbsp;<br>
binary&nbsp;value&nbsp;of&nbsp;the&nbsp;item&nbsp;at&nbsp;the&nbsp;current&nbsp;column&nbsp;and&nbsp;row.&nbsp;This&nbsp;provides&nbsp;<br>
all&nbsp;the&nbsp;arguments&nbsp;needed&nbsp;for&nbsp;a&nbsp;subsequent&nbsp;call&nbsp;to&nbsp;cbf_set_realarray,&nbsp;<br>
if&nbsp;a&nbsp;copy&nbsp;of&nbsp;the&nbsp;arry&nbsp;is&nbsp;to&nbsp;be&nbsp;made&nbsp;into&nbsp;another&nbsp;CIF&nbsp;or&nbsp;CBF.<br>
The&nbsp;variants&nbsp;cbf_get_integerarrayparameters_wdims&nbsp;and&nbsp;<br>
cbf_get_realarrayparameters_wdims&nbsp;set&nbsp;**byteorder,&nbsp;*dim1,&nbsp;*dim2,&nbsp;<br>
*dim3,&nbsp;and&nbsp;*padding&nbsp;as&nbsp;well,&nbsp;providing&nbsp;the&nbsp;additional&nbsp;parameters&nbsp;<br>
needed&nbsp;for&nbsp;a&nbsp;subsequent&nbsp;call&nbsp;to&nbsp;cbf_set_integerarray_wdims&nbsp;or&nbsp;<br>
cbf_set_realarray_wdims.<br>
The&nbsp;value&nbsp;returned&nbsp;in&nbsp;*byteorder&nbsp;is&nbsp;a&nbsp;pointer&nbsp;either&nbsp;to&nbsp;the&nbsp;string&nbsp;<br>
"little_endian"&nbsp;or&nbsp;to&nbsp;the&nbsp;string&nbsp;"big_endian".&nbsp;This&nbsp;should&nbsp;be&nbsp;the&nbsp;<br>
byte&nbsp;order&nbsp;of&nbsp;the&nbsp;data,&nbsp;not&nbsp;necessarily&nbsp;of&nbsp;the&nbsp;host&nbsp;machine.&nbsp;No&nbsp;<br>
attempt&nbsp;should&nbsp;be&nbsp;made&nbsp;to&nbsp;modify&nbsp;this&nbsp;string.&nbsp;At&nbsp;this&nbsp;time&nbsp;only&nbsp;<br>
"little_endian"&nbsp;will&nbsp;be&nbsp;returned.<br>
The&nbsp;values&nbsp;returned&nbsp;in&nbsp;*dim1,&nbsp;*dim2&nbsp;and&nbsp;*dim3&nbsp;are&nbsp;the&nbsp;sizes&nbsp;of&nbsp;the&nbsp;<br>
fastest&nbsp;changing,&nbsp;second&nbsp;fastest&nbsp;changing&nbsp;and&nbsp;third&nbsp;fastest&nbsp;changing&nbsp;<br>
dimensions&nbsp;of&nbsp;the&nbsp;array,&nbsp;if&nbsp;specified,&nbsp;or&nbsp;zero,&nbsp;if&nbsp;not&nbsp;specified.<br>
The&nbsp;value&nbsp;returned&nbsp;in&nbsp;*padding&nbsp;is&nbsp;the&nbsp;size&nbsp;of&nbsp;the&nbsp;post-data&nbsp;padding,&nbsp;<br>
if&nbsp;any&nbsp;and&nbsp;if&nbsp;specified&nbsp;in&nbsp;the&nbsp;data&nbsp;header.&nbsp;The&nbsp;value&nbsp;is&nbsp;given&nbsp;as&nbsp;a&nbsp;<br>
count&nbsp;of&nbsp;octets.<br>
If&nbsp;the&nbsp;value&nbsp;is&nbsp;not&nbsp;binary,&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_ASCII.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;compression&nbsp;&nbsp;&nbsp;Compression&nbsp;method&nbsp;used.&nbsp;elsize&nbsp;&nbsp;&nbsp;<br>
Size&nbsp;in&nbsp;bytes&nbsp;of&nbsp;each&nbsp;array&nbsp;element.&nbsp;binary_id&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;<br>
destination&nbsp;integer&nbsp;binary&nbsp;identifier.&nbsp;elsigned&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;an&nbsp;<br>
integer.&nbsp;Set&nbsp;to&nbsp;1&nbsp;if&nbsp;the&nbsp;elements&nbsp;can&nbsp;be&nbsp;read&nbsp;as&nbsp;signed&nbsp;integers.&nbsp;<br>
elunsigned&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;an&nbsp;integer.&nbsp;Set&nbsp;to&nbsp;1&nbsp;if&nbsp;the&nbsp;elements&nbsp;can&nbsp;be&nbsp;<br>
read&nbsp;as&nbsp;unsigned&nbsp;integers.&nbsp;elements&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;<br>
number&nbsp;of&nbsp;elements.&nbsp;minelement&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;smallest&nbsp;<br>
element.&nbsp;maxelement&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;largest&nbsp;element.&nbsp;<br>
byteorder&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;byte&nbsp;order.&nbsp;dim1&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;<br>
the&nbsp;destination&nbsp;fastest&nbsp;dimension.&nbsp;dim2&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;<br>
second&nbsp;fastest&nbsp;dimension.&nbsp;dim3&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;third&nbsp;<br>
fastest&nbsp;dimension.&nbsp;padding&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;padding&nbsp;size.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_realarrayparameters_wdims"><strong>get_realarrayparameters_wdims</strong></a>(*args)</dt><dd><tt><a href="#cbf_handle_struct-get_realarrayparameters_wdims">get_realarrayparameters_wdims</a>(self,&nbsp;void&nbsp;?)</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_reciprocal_cell"><strong>get_reciprocal_cell</strong></a>(*args)</dt><dd><tt><a href="#cbf_handle_struct-get_reciprocal_cell">get_reciprocal_cell</a>(self,&nbsp;void&nbsp;?)</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_timestamp"><strong>get_timestamp</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;Float&nbsp;time,Integer&nbsp;timezone<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_timestamp&nbsp;(cbf_handle&nbsp;handle,&nbsp;unsigned&nbsp;int&nbsp;reserved,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;*time,&nbsp;int&nbsp;*timezone);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_timestamp&nbsp;sets&nbsp;*time&nbsp;to&nbsp;the&nbsp;collection&nbsp;timestamp&nbsp;in&nbsp;seconds&nbsp;<br>
since&nbsp;January&nbsp;1&nbsp;1970.&nbsp;*timezone&nbsp;is&nbsp;set&nbsp;to&nbsp;timezone&nbsp;difference&nbsp;from&nbsp;<br>
UTC&nbsp;in&nbsp;minutes.&nbsp;The&nbsp;parameter&nbsp;reserved&nbsp;is&nbsp;presently&nbsp;unused&nbsp;and&nbsp;should&nbsp;<br>
be&nbsp;set&nbsp;to&nbsp;0.<br>
Either&nbsp;of&nbsp;the&nbsp;destination&nbsp;pointers&nbsp;may&nbsp;be&nbsp;NULL.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;reserved&nbsp;&nbsp;&nbsp;Unused.&nbsp;Any&nbsp;value&nbsp;other&nbsp;than&nbsp;0&nbsp;is&nbsp;<br>
invalid.&nbsp;time&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;collection&nbsp;timestamp.&nbsp;<br>
timezone&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;timezone&nbsp;difference.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_typeofvalue"><strong>get_typeofvalue</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;string<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_typeofvalue&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char&nbsp;**typeofvalue);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_value&nbsp;sets&nbsp;*typeofvalue&nbsp;to&nbsp;point&nbsp;an&nbsp;ASCII&nbsp;descriptor&nbsp;of&nbsp;the&nbsp;<br>
value&nbsp;of&nbsp;the&nbsp;item&nbsp;at&nbsp;the&nbsp;current&nbsp;column&nbsp;and&nbsp;row.&nbsp;The&nbsp;strings&nbsp;that&nbsp;may&nbsp;<br>
be&nbsp;returned&nbsp;are&nbsp;"null"&nbsp;for&nbsp;a&nbsp;null&nbsp;value&nbsp;indicated&nbsp;by&nbsp;a&nbsp;"."&nbsp;or&nbsp;a&nbsp;<br>
"?",&nbsp;"bnry"&nbsp;for&nbsp;a&nbsp;binary&nbsp;value,&nbsp;"word"&nbsp;for&nbsp;an&nbsp;unquoted&nbsp;string,&nbsp;<br>
"dblq"&nbsp;for&nbsp;a&nbsp;double-quoted&nbsp;string,&nbsp;"sglq"&nbsp;for&nbsp;a&nbsp;single-quoted&nbsp;<br>
string,&nbsp;and&nbsp;"text"&nbsp;for&nbsp;a&nbsp;semicolon-quoted&nbsp;text&nbsp;field.&nbsp;A&nbsp;field&nbsp;for&nbsp;<br>
which&nbsp;no&nbsp;value&nbsp;has&nbsp;been&nbsp;set&nbsp;sets&nbsp;*typeofvalue&nbsp;to&nbsp;NULL&nbsp;rather&nbsp;than&nbsp;to&nbsp;<br>
the&nbsp;string&nbsp;"null".<br>
The&nbsp;typeofvalue&nbsp;must&nbsp;not&nbsp;be&nbsp;modified&nbsp;by&nbsp;the&nbsp;program&nbsp;in&nbsp;any&nbsp;way.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;typeofvalue&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;<br>
type-of-value&nbsp;string&nbsp;pointer.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_unit_cell"><strong>get_unit_cell</strong></a>(*args)</dt><dd><tt><a href="#cbf_handle_struct-get_unit_cell">get_unit_cell</a>(self,&nbsp;void&nbsp;?)</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_value"><strong>get_value</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;string<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_value&nbsp;(cbf_handle&nbsp;handle,&nbsp;const&nbsp;char&nbsp;**value);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_value&nbsp;sets&nbsp;*value&nbsp;to&nbsp;point&nbsp;to&nbsp;the&nbsp;ASCII&nbsp;value&nbsp;of&nbsp;the&nbsp;item&nbsp;at&nbsp;<br>
the&nbsp;current&nbsp;column&nbsp;and&nbsp;row.&nbsp;cbf_set_value&nbsp;sets&nbsp;*value&nbsp;to&nbsp;point&nbsp;to&nbsp;the&nbsp;<br>
ASCII&nbsp;value&nbsp;of&nbsp;the&nbsp;item&nbsp;at&nbsp;the&nbsp;current&nbsp;column&nbsp;and&nbsp;row,&nbsp;creating&nbsp;the&nbsp;<br>
data&nbsp;item&nbsp;if&nbsp;necessary&nbsp;and&nbsp;initializing&nbsp;it&nbsp;to&nbsp;a&nbsp;copy&nbsp;of&nbsp;defaultvalue.<br>
If&nbsp;the&nbsp;value&nbsp;is&nbsp;not&nbsp;ASCII,&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_BINARY.<br>
The&nbsp;value&nbsp;will&nbsp;be&nbsp;valid&nbsp;as&nbsp;long&nbsp;as&nbsp;the&nbsp;item&nbsp;exists&nbsp;and&nbsp;has&nbsp;not&nbsp;been&nbsp;<br>
set&nbsp;to&nbsp;a&nbsp;new&nbsp;value.<br>
The&nbsp;value&nbsp;must&nbsp;not&nbsp;be&nbsp;modified&nbsp;by&nbsp;the&nbsp;program&nbsp;in&nbsp;any&nbsp;way.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;value&nbsp;&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;value&nbsp;<br>
pointer.&nbsp;value&nbsp;&nbsp;&nbsp;&nbsp;Default&nbsp;value&nbsp;character&nbsp;string.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-get_wavelength"><strong>get_wavelength</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;double<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_wavelength&nbsp;(cbf_handle&nbsp;handle,&nbsp;double&nbsp;*wavelength);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_wavelength&nbsp;sets&nbsp;*wavelength&nbsp;to&nbsp;the&nbsp;current&nbsp;wavelength&nbsp;in&nbsp;<br>
Angstrom.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;wavelength&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-insert_row"><strong>insert_row</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;Integer<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_insert_row&nbsp;(cbf_handle&nbsp;handle,&nbsp;unsigned&nbsp;int&nbsp;rownumber);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_insert_row&nbsp;adds&nbsp;a&nbsp;new&nbsp;row&nbsp;to&nbsp;the&nbsp;current&nbsp;category.&nbsp;The&nbsp;new&nbsp;row&nbsp;is&nbsp;<br>
inserted&nbsp;as&nbsp;row&nbsp;rownumber&nbsp;and&nbsp;existing&nbsp;rows&nbsp;starting&nbsp;from&nbsp;rownumber&nbsp;<br>
are&nbsp;moved&nbsp;up&nbsp;by&nbsp;1.&nbsp;The&nbsp;new&nbsp;row&nbsp;becomes&nbsp;the&nbsp;current&nbsp;row.<br>
If&nbsp;the&nbsp;category&nbsp;has&nbsp;fewer&nbsp;than&nbsp;rownumber&nbsp;rows,&nbsp;the&nbsp;function&nbsp;returns&nbsp;<br>
CBF_NOTFOUND.<br>
The&nbsp;row&nbsp;numbers&nbsp;start&nbsp;from&nbsp;0.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;rownumber&nbsp;&nbsp;&nbsp;The&nbsp;row&nbsp;number&nbsp;of&nbsp;the&nbsp;new&nbsp;row.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-new_category"><strong>new_category</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;string<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_new_category&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char&nbsp;*categoryname);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_new_category&nbsp;creates&nbsp;a&nbsp;new&nbsp;category&nbsp;in&nbsp;the&nbsp;current&nbsp;data&nbsp;block&nbsp;<br>
with&nbsp;name&nbsp;categoryname&nbsp;and&nbsp;makes&nbsp;it&nbsp;the&nbsp;current&nbsp;category.<br>
If&nbsp;a&nbsp;category&nbsp;with&nbsp;this&nbsp;name&nbsp;already&nbsp;exists,&nbsp;the&nbsp;existing&nbsp;category&nbsp;<br>
becomes&nbsp;the&nbsp;current&nbsp;category.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;categoryname&nbsp;&nbsp;&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;new&nbsp;<br>
category.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-new_column"><strong>new_column</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;string<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_new_column&nbsp;(cbf_handle&nbsp;handle,&nbsp;const&nbsp;char&nbsp;*columnname);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_new_column&nbsp;creates&nbsp;a&nbsp;new&nbsp;column&nbsp;in&nbsp;the&nbsp;current&nbsp;category&nbsp;with&nbsp;name&nbsp;<br>
columnname&nbsp;and&nbsp;makes&nbsp;it&nbsp;the&nbsp;current&nbsp;column.<br>
If&nbsp;a&nbsp;column&nbsp;with&nbsp;this&nbsp;name&nbsp;already&nbsp;exists,&nbsp;the&nbsp;existing&nbsp;column&nbsp;<br>
becomes&nbsp;the&nbsp;current&nbsp;category.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;columnname&nbsp;&nbsp;&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;new&nbsp;column.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-new_datablock"><strong>new_datablock</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;string<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_new_datablock&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char&nbsp;*datablockname);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_new_datablock&nbsp;creates&nbsp;a&nbsp;new&nbsp;data&nbsp;block&nbsp;with&nbsp;name&nbsp;datablockname&nbsp;<br>
and&nbsp;makes&nbsp;it&nbsp;the&nbsp;current&nbsp;data&nbsp;block.&nbsp;cbf_new_saveframe&nbsp;creates&nbsp;a&nbsp;new&nbsp;<br>
save&nbsp;frame&nbsp;with&nbsp;name&nbsp;saveframename&nbsp;within&nbsp;the&nbsp;current&nbsp;data&nbsp;block&nbsp;and&nbsp;<br>
makes&nbsp;the&nbsp;new&nbsp;save&nbsp;frame&nbsp;the&nbsp;current&nbsp;save&nbsp;frame.<br>
If&nbsp;a&nbsp;data&nbsp;block&nbsp;or&nbsp;save&nbsp;frame&nbsp;with&nbsp;this&nbsp;name&nbsp;already&nbsp;exists,&nbsp;the&nbsp;<br>
existing&nbsp;data&nbsp;block&nbsp;or&nbsp;save&nbsp;frame&nbsp;becomes&nbsp;the&nbsp;current&nbsp;data&nbsp;block&nbsp;or&nbsp;<br>
save&nbsp;frame.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;datablockname&nbsp;&nbsp;&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;new&nbsp;data&nbsp;<br>
block.&nbsp;saveframename&nbsp;&nbsp;&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;new&nbsp;save&nbsp;frame.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-new_row"><strong>new_row</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_new_row&nbsp;(cbf_handle&nbsp;handle);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_new_row&nbsp;adds&nbsp;a&nbsp;new&nbsp;row&nbsp;to&nbsp;the&nbsp;current&nbsp;category&nbsp;and&nbsp;makes&nbsp;it&nbsp;the&nbsp;<br>
current&nbsp;row.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-new_saveframe"><strong>new_saveframe</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;string<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_new_saveframe&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char&nbsp;*saveframename);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_new_datablock&nbsp;creates&nbsp;a&nbsp;new&nbsp;data&nbsp;block&nbsp;with&nbsp;name&nbsp;datablockname&nbsp;<br>
and&nbsp;makes&nbsp;it&nbsp;the&nbsp;current&nbsp;data&nbsp;block.&nbsp;cbf_new_saveframe&nbsp;creates&nbsp;a&nbsp;new&nbsp;<br>
save&nbsp;frame&nbsp;with&nbsp;name&nbsp;saveframename&nbsp;within&nbsp;the&nbsp;current&nbsp;data&nbsp;block&nbsp;and&nbsp;<br>
makes&nbsp;the&nbsp;new&nbsp;save&nbsp;frame&nbsp;the&nbsp;current&nbsp;save&nbsp;frame.<br>
If&nbsp;a&nbsp;data&nbsp;block&nbsp;or&nbsp;save&nbsp;frame&nbsp;with&nbsp;this&nbsp;name&nbsp;already&nbsp;exists,&nbsp;the&nbsp;<br>
existing&nbsp;data&nbsp;block&nbsp;or&nbsp;save&nbsp;frame&nbsp;becomes&nbsp;the&nbsp;current&nbsp;data&nbsp;block&nbsp;or&nbsp;<br>
save&nbsp;frame.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;datablockname&nbsp;&nbsp;&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;new&nbsp;data&nbsp;<br>
block.&nbsp;saveframename&nbsp;&nbsp;&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;new&nbsp;save&nbsp;frame.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-next_category"><strong>next_category</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_next_category&nbsp;(cbf_handle&nbsp;handle);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_next_category&nbsp;makes&nbsp;the&nbsp;category&nbsp;following&nbsp;the&nbsp;current&nbsp;category&nbsp;<br>
in&nbsp;the&nbsp;current&nbsp;data&nbsp;block&nbsp;the&nbsp;current&nbsp;category.<br>
If&nbsp;there&nbsp;are&nbsp;no&nbsp;more&nbsp;categories,&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_NOTFOUND.<br>
The&nbsp;current&nbsp;column&nbsp;and&nbsp;row&nbsp;become&nbsp;undefined.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-next_column"><strong>next_column</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_next_column&nbsp;(cbf_handle&nbsp;handle);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_next_column&nbsp;makes&nbsp;the&nbsp;column&nbsp;following&nbsp;the&nbsp;current&nbsp;column&nbsp;in&nbsp;the&nbsp;<br>
current&nbsp;category&nbsp;the&nbsp;current&nbsp;column.<br>
If&nbsp;there&nbsp;are&nbsp;no&nbsp;more&nbsp;columns,&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_NOTFOUND.<br>
The&nbsp;current&nbsp;row&nbsp;is&nbsp;not&nbsp;affected.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-next_datablock"><strong>next_datablock</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_next_datablock&nbsp;(cbf_handle&nbsp;handle);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_next_datablock&nbsp;makes&nbsp;the&nbsp;data&nbsp;block&nbsp;following&nbsp;the&nbsp;current&nbsp;data&nbsp;<br>
block&nbsp;the&nbsp;current&nbsp;data&nbsp;block.<br>
If&nbsp;there&nbsp;are&nbsp;no&nbsp;more&nbsp;data&nbsp;blocks,&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_NOTFOUND.<br>
The&nbsp;current&nbsp;category&nbsp;becomes&nbsp;undefined.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-next_row"><strong>next_row</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_next_row&nbsp;(cbf_handle&nbsp;handle);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_next_row&nbsp;makes&nbsp;the&nbsp;row&nbsp;following&nbsp;the&nbsp;current&nbsp;row&nbsp;in&nbsp;the&nbsp;current&nbsp;<br>
category&nbsp;the&nbsp;current&nbsp;row.<br>
If&nbsp;there&nbsp;are&nbsp;no&nbsp;more&nbsp;rows,&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_NOTFOUND.<br>
The&nbsp;current&nbsp;column&nbsp;is&nbsp;not&nbsp;affected.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-read_file"><strong>read_file</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;String&nbsp;filename,Integer&nbsp;headers<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_read_file&nbsp;(cbf_handle&nbsp;handle,&nbsp;FILE&nbsp;*file,&nbsp;int&nbsp;headers);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_read_file&nbsp;reads&nbsp;the&nbsp;CBF&nbsp;or&nbsp;CIF&nbsp;file&nbsp;file&nbsp;into&nbsp;the&nbsp;CBF&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;<br>
specified&nbsp;by&nbsp;handle,&nbsp;using&nbsp;the&nbsp;CIF&nbsp;1.0&nbsp;convention&nbsp;of&nbsp;80&nbsp;character&nbsp;<br>
lines.&nbsp;cbf_read_widefile&nbsp;reads&nbsp;the&nbsp;CBF&nbsp;or&nbsp;CIF&nbsp;file&nbsp;file&nbsp;into&nbsp;the&nbsp;CBF&nbsp;<br>
<a href="__builtin__.html#object">object</a>&nbsp;specified&nbsp;by&nbsp;handle,&nbsp;using&nbsp;the&nbsp;CIF&nbsp;1.1&nbsp;convention&nbsp;of&nbsp;2048&nbsp;<br>
character&nbsp;lines.&nbsp;A&nbsp;warning&nbsp;is&nbsp;issued&nbsp;to&nbsp;stderr&nbsp;for&nbsp;ascii&nbsp;lines&nbsp;over&nbsp;<br>
the&nbsp;limit.&nbsp;No&nbsp;test&nbsp;is&nbsp;performed&nbsp;on&nbsp;binary&nbsp;sections.<br>
Validation&nbsp;is&nbsp;performed&nbsp;in&nbsp;three&nbsp;ways&nbsp;levels:&nbsp;during&nbsp;the&nbsp;lexical&nbsp;<br>
scan,&nbsp;during&nbsp;the&nbsp;parse,&nbsp;and,&nbsp;if&nbsp;a&nbsp;dictionary&nbsp;was&nbsp;converted,&nbsp;against&nbsp;<br>
the&nbsp;value&nbsp;types,&nbsp;value&nbsp;enumerations,&nbsp;categories&nbsp;and&nbsp;parent-child&nbsp;<br>
relationships&nbsp;specified&nbsp;in&nbsp;the&nbsp;dictionary.<br>
headers&nbsp;controls&nbsp;the&nbsp;interprestation&nbsp;of&nbsp;binary&nbsp;section&nbsp;headers&nbsp;of&nbsp;<br>
imgCIF&nbsp;files.<br>
MSG_DIGEST:&nbsp;&nbsp;&nbsp;Instructs&nbsp;CBFlib&nbsp;to&nbsp;check&nbsp;that&nbsp;the&nbsp;digest&nbsp;of&nbsp;the&nbsp;binary&nbsp;<br>
section&nbsp;matches&nbsp;any&nbsp;header&nbsp;value.&nbsp;If&nbsp;the&nbsp;digests&nbsp;do&nbsp;not&nbsp;match,&nbsp;the&nbsp;<br>
call&nbsp;will&nbsp;return&nbsp;CBF_FORMAT.&nbsp;This&nbsp;evaluation&nbsp;and&nbsp;comparison&nbsp;is&nbsp;<br>
delayed&nbsp;(a&nbsp;"lazy"&nbsp;evaluation)&nbsp;to&nbsp;ensure&nbsp;maximal&nbsp;processing&nbsp;<br>
efficiency.&nbsp;If&nbsp;an&nbsp;immediately&nbsp;evaluation&nbsp;is&nbsp;required,&nbsp;see&nbsp;<br>
MSG_DIGESTNOW,&nbsp;below.&nbsp;MSG_DIGESTNOW:&nbsp;&nbsp;&nbsp;Instructs&nbsp;CBFlib&nbsp;to&nbsp;check&nbsp;that&nbsp;<br>
the&nbsp;digest&nbsp;of&nbsp;the&nbsp;binary&nbsp;section&nbsp;matches&nbsp;any&nbsp;header&nbsp;value.&nbsp;If&nbsp;the&nbsp;<br>
digests&nbsp;do&nbsp;not&nbsp;match,&nbsp;the&nbsp;call&nbsp;will&nbsp;return&nbsp;CBF_FORMAT.&nbsp;This&nbsp;<br>
evaluation&nbsp;and&nbsp;comparison&nbsp;is&nbsp;performed&nbsp;during&nbsp;initial&nbsp;parsing&nbsp;of&nbsp;the&nbsp;<br>
section&nbsp;to&nbsp;ensure&nbsp;timely&nbsp;error&nbsp;reporting&nbsp;at&nbsp;the&nbsp;expense&nbsp;of&nbsp;processing&nbsp;<br>
efficiency.&nbsp;If&nbsp;a&nbsp;more&nbsp;efficient&nbsp;delayed&nbsp;("lazy")&nbsp;evaluation&nbsp;is&nbsp;<br>
required,&nbsp;see&nbsp;MSG_DIGESTNOW,&nbsp;below.&nbsp;MSG_NODIGEST:&nbsp;&nbsp;&nbsp;Do&nbsp;not&nbsp;check&nbsp;the&nbsp;<br>
digest&nbsp;(default).<br>
CBFlib&nbsp;defers&nbsp;reading&nbsp;binary&nbsp;sections&nbsp;as&nbsp;long&nbsp;as&nbsp;possible.&nbsp;In&nbsp;the&nbsp;<br>
current&nbsp;version&nbsp;of&nbsp;CBFlib,&nbsp;this&nbsp;means&nbsp;that:<br>
1.&nbsp;The&nbsp;file&nbsp;must&nbsp;be&nbsp;a&nbsp;random-access&nbsp;file&nbsp;opened&nbsp;in&nbsp;binary&nbsp;mode&nbsp;(fopen</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-read_template"><strong>read_template</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;String&nbsp;filename<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_read_template&nbsp;(cbf_handle&nbsp;handle,&nbsp;FILE&nbsp;*file);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_read_template&nbsp;reads&nbsp;the&nbsp;CBF&nbsp;or&nbsp;CIF&nbsp;file&nbsp;file&nbsp;into&nbsp;the&nbsp;CBF&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;<br>
specified&nbsp;by&nbsp;handle&nbsp;and&nbsp;selects&nbsp;the&nbsp;first&nbsp;datablock&nbsp;as&nbsp;the&nbsp;current&nbsp;<br>
datablock.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;a&nbsp;CBF&nbsp;handle.&nbsp;file&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;a&nbsp;file&nbsp;<br>
descriptor.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-read_widefile"><strong>read_widefile</strong></a>(*args)</dt><dd><tt><a href="#cbf_handle_struct-read_widefile">read_widefile</a>(self,&nbsp;void&nbsp;?)</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-remove_category"><strong>remove_category</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_remove_category&nbsp;(cbf_handle&nbsp;handle);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_remove_category&nbsp;deletes&nbsp;the&nbsp;current&nbsp;category.<br>
The&nbsp;current&nbsp;category&nbsp;becomes&nbsp;undefined.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-remove_column"><strong>remove_column</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_remove_column&nbsp;(cbf_handle&nbsp;handle);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_remove_column&nbsp;deletes&nbsp;the&nbsp;current&nbsp;column.<br>
The&nbsp;current&nbsp;column&nbsp;becomes&nbsp;undefined.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-remove_datablock"><strong>remove_datablock</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_remove_datablock&nbsp;(cbf_handle&nbsp;handle);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_remove_datablock&nbsp;deletes&nbsp;the&nbsp;current&nbsp;data&nbsp;block.&nbsp;<br>
cbf_remove_saveframe&nbsp;deletes&nbsp;the&nbsp;current&nbsp;save&nbsp;frame.<br>
The&nbsp;current&nbsp;data&nbsp;block&nbsp;becomes&nbsp;undefined.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-remove_row"><strong>remove_row</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_remove_row&nbsp;(cbf_handle&nbsp;handle);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_remove_row&nbsp;deletes&nbsp;the&nbsp;current&nbsp;row&nbsp;in&nbsp;the&nbsp;current&nbsp;category.<br>
If&nbsp;the&nbsp;current&nbsp;row&nbsp;was&nbsp;the&nbsp;last&nbsp;row,&nbsp;it&nbsp;will&nbsp;move&nbsp;down&nbsp;by&nbsp;1,&nbsp;<br>
otherwise,&nbsp;it&nbsp;will&nbsp;remain&nbsp;the&nbsp;same.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-remove_saveframe"><strong>remove_saveframe</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_remove_saveframe&nbsp;(cbf_handle&nbsp;handle);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_remove_datablock&nbsp;deletes&nbsp;the&nbsp;current&nbsp;data&nbsp;block.&nbsp;<br>
cbf_remove_saveframe&nbsp;deletes&nbsp;the&nbsp;current&nbsp;save&nbsp;frame.<br>
The&nbsp;current&nbsp;data&nbsp;block&nbsp;becomes&nbsp;undefined.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-require_category"><strong>require_category</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;string<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_require_category&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char&nbsp;&nbsp;&nbsp;&nbsp;*categoryname);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_rewuire_category&nbsp;makes&nbsp;the&nbsp;category&nbsp;in&nbsp;the&nbsp;current&nbsp;data&nbsp;block&nbsp;<br>
with&nbsp;name&nbsp;categoryname&nbsp;the&nbsp;current&nbsp;category,&nbsp;if&nbsp;it&nbsp;exists,&nbsp;or&nbsp;creates&nbsp;<br>
the&nbsp;catagory&nbsp;if&nbsp;it&nbsp;does&nbsp;not&nbsp;exist.<br>
The&nbsp;comparison&nbsp;is&nbsp;case-insensitive.<br>
The&nbsp;current&nbsp;column&nbsp;and&nbsp;row&nbsp;become&nbsp;undefined.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;categoryname&nbsp;&nbsp;&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;category&nbsp;to&nbsp;<br>
find.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-require_category_root"><strong>require_category_root</strong></a>(*args)</dt><dd><tt><a href="#cbf_handle_struct-require_category_root">require_category_root</a>(self,&nbsp;char&nbsp;categoryname)&nbsp;-&gt;&nbsp;char</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-require_column"><strong>require_column</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;string<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_require_column&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char&nbsp;*columnname);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_require_column&nbsp;makes&nbsp;the&nbsp;columns&nbsp;in&nbsp;the&nbsp;current&nbsp;category&nbsp;with&nbsp;<br>
name&nbsp;columnname&nbsp;the&nbsp;current&nbsp;column,&nbsp;if&nbsp;it&nbsp;exists,&nbsp;or&nbsp;creates&nbsp;it&nbsp;if&nbsp;it&nbsp;<br>
does&nbsp;not.<br>
The&nbsp;comparison&nbsp;is&nbsp;case-insensitive.<br>
The&nbsp;current&nbsp;row&nbsp;is&nbsp;not&nbsp;affected.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;columnname&nbsp;&nbsp;&nbsp;The&nbsp;name&nbsp;of&nbsp;column&nbsp;to&nbsp;find.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-require_column_doublevalue"><strong>require_column_doublevalue</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;Float&nbsp;defaultvalue<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;String&nbsp;columnname,Float&nbsp;Value<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_require_column_doublevalue&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char&nbsp;&nbsp;&nbsp;&nbsp;*columnname,&nbsp;double&nbsp;*number,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;double&nbsp;defaultvalue);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_require_column_doublevalue&nbsp;sets&nbsp;*number&nbsp;to&nbsp;the&nbsp;value&nbsp;of&nbsp;the&nbsp;ASCII&nbsp;<br>
item&nbsp;at&nbsp;the&nbsp;current&nbsp;row&nbsp;for&nbsp;the&nbsp;column&nbsp;given&nbsp;with&nbsp;the&nbsp;name&nbsp;given&nbsp;by&nbsp;<br>
*columnname,&nbsp;with&nbsp;the&nbsp;value&nbsp;interpreted&nbsp;as&nbsp;a&nbsp;decimal&nbsp;floating-point&nbsp;<br>
number,&nbsp;or&nbsp;to&nbsp;the&nbsp;number&nbsp;given&nbsp;by&nbsp;defaultvalue&nbsp;if&nbsp;the&nbsp;item&nbsp;cannot&nbsp;be&nbsp;<br>
found.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;columnname&nbsp;&nbsp;&nbsp;Name&nbsp;of&nbsp;the&nbsp;column&nbsp;containing&nbsp;the&nbsp;<br>
number.&nbsp;number&nbsp;&nbsp;&nbsp;pointer&nbsp;to&nbsp;the&nbsp;location&nbsp;to&nbsp;receive&nbsp;the&nbsp;<br>
floating-point&nbsp;value.&nbsp;defaultvalue&nbsp;&nbsp;&nbsp;Value&nbsp;to&nbsp;use&nbsp;if&nbsp;the&nbsp;requested&nbsp;<br>
column&nbsp;and&nbsp;value&nbsp;cannot&nbsp;be&nbsp;found.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-require_column_integervalue"><strong>require_column_integervalue</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;Int&nbsp;Value<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;String&nbsp;Columnvalue,Int&nbsp;default<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_require_column_integervalue&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char&nbsp;&nbsp;&nbsp;&nbsp;*columnname,&nbsp;int&nbsp;*number,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;int&nbsp;defaultvalue);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_require_column_doublevalue&nbsp;sets&nbsp;*number&nbsp;to&nbsp;the&nbsp;value&nbsp;of&nbsp;the&nbsp;ASCII&nbsp;<br>
item&nbsp;at&nbsp;the&nbsp;current&nbsp;row&nbsp;for&nbsp;the&nbsp;column&nbsp;given&nbsp;with&nbsp;the&nbsp;name&nbsp;given&nbsp;by&nbsp;<br>
*columnname,&nbsp;with&nbsp;the&nbsp;value&nbsp;interpreted&nbsp;as&nbsp;an&nbsp;integer&nbsp;number,&nbsp;or&nbsp;to&nbsp;<br>
the&nbsp;number&nbsp;given&nbsp;by&nbsp;defaultvalue&nbsp;if&nbsp;the&nbsp;item&nbsp;cannot&nbsp;be&nbsp;found.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;columnname&nbsp;&nbsp;&nbsp;Name&nbsp;of&nbsp;the&nbsp;column&nbsp;containing&nbsp;the&nbsp;<br>
number.&nbsp;number&nbsp;&nbsp;&nbsp;pointer&nbsp;to&nbsp;the&nbsp;location&nbsp;to&nbsp;receive&nbsp;the&nbsp;integer&nbsp;<br>
value.&nbsp;defaultvalue&nbsp;&nbsp;&nbsp;Value&nbsp;to&nbsp;use&nbsp;if&nbsp;the&nbsp;requested&nbsp;column&nbsp;and&nbsp;value&nbsp;<br>
cannot&nbsp;be&nbsp;found.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-require_column_value"><strong>require_column_value</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;String&nbsp;Name<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;String&nbsp;columnnanme,String&nbsp;Default<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_require_column_value&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char&nbsp;&nbsp;&nbsp;&nbsp;*columnname,&nbsp;const&nbsp;char&nbsp;**value,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char&nbsp;*defaultvalue);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_require_column_doublevalue&nbsp;sets&nbsp;*value&nbsp;to&nbsp;the&nbsp;ASCII&nbsp;item&nbsp;at&nbsp;the&nbsp;<br>
current&nbsp;row&nbsp;for&nbsp;the&nbsp;column&nbsp;given&nbsp;with&nbsp;the&nbsp;name&nbsp;given&nbsp;by&nbsp;*columnname,&nbsp;<br>
or&nbsp;to&nbsp;the&nbsp;string&nbsp;given&nbsp;by&nbsp;defaultvalue&nbsp;if&nbsp;the&nbsp;item&nbsp;cannot&nbsp;be&nbsp;found.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;columnname&nbsp;&nbsp;&nbsp;Name&nbsp;of&nbsp;the&nbsp;column&nbsp;containing&nbsp;the&nbsp;<br>
number.&nbsp;value&nbsp;&nbsp;&nbsp;pointer&nbsp;to&nbsp;the&nbsp;location&nbsp;to&nbsp;receive&nbsp;the&nbsp;value.&nbsp;<br>
defaultvalue&nbsp;&nbsp;&nbsp;Value&nbsp;to&nbsp;use&nbsp;if&nbsp;the&nbsp;requested&nbsp;column&nbsp;and&nbsp;value&nbsp;cannot&nbsp;<br>
be&nbsp;found.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-require_datablock"><strong>require_datablock</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;string<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_require_datablock&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char&nbsp;&nbsp;&nbsp;&nbsp;*datablockname);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_require_datablock&nbsp;makes&nbsp;the&nbsp;data&nbsp;block&nbsp;with&nbsp;name&nbsp;datablockname&nbsp;<br>
the&nbsp;current&nbsp;data&nbsp;block,&nbsp;if&nbsp;it&nbsp;exists,&nbsp;or&nbsp;creates&nbsp;it&nbsp;if&nbsp;it&nbsp;does&nbsp;not.<br>
The&nbsp;comparison&nbsp;is&nbsp;case-insensitive.<br>
The&nbsp;current&nbsp;category&nbsp;becomes&nbsp;undefined.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;datablockname&nbsp;&nbsp;&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;data&nbsp;<br>
block&nbsp;to&nbsp;find&nbsp;or&nbsp;create.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-require_doublevalue"><strong>require_doublevalue</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;Float&nbsp;Number<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;Float&nbsp;Default<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_require_doublevalue&nbsp;(cbf_handle&nbsp;handle,&nbsp;double&nbsp;*number,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;&nbsp;&nbsp;&nbsp;defaultvalue);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_doublevalue&nbsp;sets&nbsp;*number&nbsp;to&nbsp;the&nbsp;value&nbsp;of&nbsp;the&nbsp;ASCII&nbsp;item&nbsp;at&nbsp;<br>
the&nbsp;current&nbsp;column&nbsp;and&nbsp;row&nbsp;interpreted&nbsp;as&nbsp;a&nbsp;decimal&nbsp;floating-point&nbsp;<br>
number.&nbsp;cbf_require_doublevalue&nbsp;sets&nbsp;*number&nbsp;to&nbsp;the&nbsp;value&nbsp;of&nbsp;the&nbsp;<br>
ASCII&nbsp;item&nbsp;at&nbsp;the&nbsp;current&nbsp;column&nbsp;and&nbsp;row&nbsp;interpreted&nbsp;as&nbsp;a&nbsp;decimal&nbsp;<br>
floating-point&nbsp;number,&nbsp;setting&nbsp;it&nbsp;to&nbsp;defaultvalue&nbsp;if&nbsp;necessary.<br>
If&nbsp;the&nbsp;value&nbsp;is&nbsp;not&nbsp;ASCII,&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_BINARY.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;number&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;<br>
number.&nbsp;defaultvalue&nbsp;&nbsp;&nbsp;default&nbsp;number&nbsp;value.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-require_integervalue"><strong>require_integervalue</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;Int&nbsp;number<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;Int&nbsp;thedefault<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_require_integervalue&nbsp;(cbf_handle&nbsp;handle,&nbsp;int&nbsp;*number,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;&nbsp;&nbsp;&nbsp;defaultvalue);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_integervalue&nbsp;sets&nbsp;*number&nbsp;to&nbsp;the&nbsp;value&nbsp;of&nbsp;the&nbsp;ASCII&nbsp;item&nbsp;at&nbsp;<br>
the&nbsp;current&nbsp;column&nbsp;and&nbsp;row&nbsp;interpreted&nbsp;as&nbsp;a&nbsp;decimal&nbsp;integer.&nbsp;<br>
cbf_require_integervalue&nbsp;sets&nbsp;*number&nbsp;to&nbsp;the&nbsp;value&nbsp;of&nbsp;the&nbsp;ASCII&nbsp;item&nbsp;<br>
at&nbsp;the&nbsp;current&nbsp;column&nbsp;and&nbsp;row&nbsp;interpreted&nbsp;as&nbsp;a&nbsp;decimal&nbsp;integer,&nbsp;<br>
setting&nbsp;it&nbsp;to&nbsp;defaultvalue&nbsp;if&nbsp;necessary.<br>
If&nbsp;the&nbsp;value&nbsp;is&nbsp;not&nbsp;ASCII,&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_BINARY.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;number&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;pointer&nbsp;to&nbsp;the&nbsp;number.&nbsp;<br>
defaultvalue&nbsp;&nbsp;&nbsp;default&nbsp;number&nbsp;value.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-require_tag_root"><strong>require_tag_root</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;String&nbsp;tagroot<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;String&nbsp;tagname<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_require_tag_root&nbsp;(cbf_handle&nbsp;handle,&nbsp;const&nbsp;char*&nbsp;tagname,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char**&nbsp;tagroot);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_find_tag_root&nbsp;sets&nbsp;*tagroot&nbsp;to&nbsp;the&nbsp;root&nbsp;tag&nbsp;of&nbsp;which&nbsp;tagname&nbsp;is&nbsp;<br>
an&nbsp;alias.&nbsp;cbf_set_tag_root&nbsp;sets&nbsp;tagname&nbsp;as&nbsp;an&nbsp;alias&nbsp;of&nbsp;tagroot_in&nbsp;in&nbsp;<br>
the&nbsp;dictionary&nbsp;associated&nbsp;with&nbsp;handle,&nbsp;creating&nbsp;the&nbsp;dictionary&nbsp;if&nbsp;<br>
necessary.&nbsp;cbf_require_tag_root&nbsp;sets&nbsp;*tagroot&nbsp;to&nbsp;the&nbsp;root&nbsp;tag&nbsp;of&nbsp;<br>
which&nbsp;tagname&nbsp;is&nbsp;an&nbsp;alias,&nbsp;if&nbsp;there&nbsp;is&nbsp;one,&nbsp;or&nbsp;to&nbsp;the&nbsp;value&nbsp;of&nbsp;<br>
tagname,&nbsp;if&nbsp;tagname&nbsp;is&nbsp;not&nbsp;an&nbsp;alias.<br>
A&nbsp;returned&nbsp;tagroot&nbsp;string&nbsp;must&nbsp;not&nbsp;be&nbsp;modified&nbsp;in&nbsp;any&nbsp;way.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;tagname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;tag&nbsp;name&nbsp;which&nbsp;may&nbsp;be&nbsp;an&nbsp;alias.&nbsp;<br>
tagroot&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;pointer&nbsp;to&nbsp;a&nbsp;returned&nbsp;tag&nbsp;root&nbsp;name.&nbsp;tagroot_in&nbsp;&nbsp;&nbsp;input&nbsp;<br>
tag&nbsp;root&nbsp;name.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-require_value"><strong>require_value</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;String&nbsp;Value<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;String&nbsp;defaultvalue<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_require_value&nbsp;(cbf_handle&nbsp;handle,&nbsp;const&nbsp;char&nbsp;**value,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;&nbsp;&nbsp;&nbsp;char&nbsp;*defaultvalue&nbsp;);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_value&nbsp;sets&nbsp;*value&nbsp;to&nbsp;point&nbsp;to&nbsp;the&nbsp;ASCII&nbsp;value&nbsp;of&nbsp;the&nbsp;item&nbsp;at&nbsp;<br>
the&nbsp;current&nbsp;column&nbsp;and&nbsp;row.&nbsp;cbf_set_value&nbsp;sets&nbsp;*value&nbsp;to&nbsp;point&nbsp;to&nbsp;the&nbsp;<br>
ASCII&nbsp;value&nbsp;of&nbsp;the&nbsp;item&nbsp;at&nbsp;the&nbsp;current&nbsp;column&nbsp;and&nbsp;row,&nbsp;creating&nbsp;the&nbsp;<br>
data&nbsp;item&nbsp;if&nbsp;necessary&nbsp;and&nbsp;initializing&nbsp;it&nbsp;to&nbsp;a&nbsp;copy&nbsp;of&nbsp;defaultvalue.<br>
If&nbsp;the&nbsp;value&nbsp;is&nbsp;not&nbsp;ASCII,&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_BINARY.<br>
The&nbsp;value&nbsp;will&nbsp;be&nbsp;valid&nbsp;as&nbsp;long&nbsp;as&nbsp;the&nbsp;item&nbsp;exists&nbsp;and&nbsp;has&nbsp;not&nbsp;been&nbsp;<br>
set&nbsp;to&nbsp;a&nbsp;new&nbsp;value.<br>
The&nbsp;value&nbsp;must&nbsp;not&nbsp;be&nbsp;modified&nbsp;by&nbsp;the&nbsp;program&nbsp;in&nbsp;any&nbsp;way.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;value&nbsp;&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;value&nbsp;<br>
pointer.&nbsp;value&nbsp;&nbsp;&nbsp;&nbsp;Default&nbsp;value&nbsp;character&nbsp;string.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-reset_category"><strong>reset_category</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_reset_category&nbsp;(cbf_handle&nbsp;handle);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_reset_category&nbsp;deletes&nbsp;all&nbsp;columns&nbsp;and&nbsp;rows&nbsp;from&nbsp;current&nbsp;category.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-reset_datablock"><strong>reset_datablock</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_reset_datablock&nbsp;(cbf_handle&nbsp;handle);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_reset_datablock&nbsp;deletes&nbsp;all&nbsp;categories&nbsp;from&nbsp;the&nbsp;current&nbsp;data&nbsp;<br>
block.&nbsp;cbf_reset_saveframe&nbsp;deletes&nbsp;all&nbsp;categories&nbsp;from&nbsp;the&nbsp;current&nbsp;<br>
save&nbsp;frame.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-reset_datablocks"><strong>reset_datablocks</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_reset_datablocks&nbsp;(cbf_handle&nbsp;handle);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_reset_datablocks&nbsp;deletes&nbsp;all&nbsp;categories&nbsp;from&nbsp;all&nbsp;data&nbsp;blocks.<br>
The&nbsp;current&nbsp;data&nbsp;block&nbsp;does&nbsp;not&nbsp;change.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-reset_saveframe"><strong>reset_saveframe</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_reset_saveframe&nbsp;(cbf_handle&nbsp;handle);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_reset_datablock&nbsp;deletes&nbsp;all&nbsp;categories&nbsp;from&nbsp;the&nbsp;current&nbsp;data&nbsp;<br>
block.&nbsp;cbf_reset_saveframe&nbsp;deletes&nbsp;all&nbsp;categories&nbsp;from&nbsp;the&nbsp;current&nbsp;<br>
save&nbsp;frame.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-rewind_blockitem"><strong>rewind_blockitem</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;CBF_NODETYPE<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_rewind_blockitem&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF_NODETYPE&nbsp;*&nbsp;type);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_rewind_category&nbsp;makes&nbsp;the&nbsp;first&nbsp;category&nbsp;in&nbsp;the&nbsp;current&nbsp;data&nbsp;<br>
block&nbsp;the&nbsp;current&nbsp;category.&nbsp;cbf_rewind_saveframe&nbsp;makes&nbsp;the&nbsp;first&nbsp;<br>
saveframe&nbsp;in&nbsp;the&nbsp;current&nbsp;data&nbsp;block&nbsp;the&nbsp;current&nbsp;saveframe.&nbsp;<br>
cbf_rewind_blockitem&nbsp;makes&nbsp;the&nbsp;first&nbsp;blockitem&nbsp;(category&nbsp;or&nbsp;<br>
saveframe)&nbsp;in&nbsp;the&nbsp;current&nbsp;data&nbsp;block&nbsp;the&nbsp;current&nbsp;blockitem.<br>
If&nbsp;there&nbsp;are&nbsp;no&nbsp;categories,&nbsp;saveframes&nbsp;or&nbsp;blockitems&nbsp;the&nbsp;function&nbsp;<br>
returns&nbsp;CBF_NOTFOUND.<br>
The&nbsp;current&nbsp;column&nbsp;and&nbsp;row&nbsp;become&nbsp;undefined.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-rewind_category"><strong>rewind_category</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_rewind_category&nbsp;(cbf_handle&nbsp;handle);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_rewind_category&nbsp;makes&nbsp;the&nbsp;first&nbsp;category&nbsp;in&nbsp;the&nbsp;current&nbsp;data&nbsp;<br>
block&nbsp;the&nbsp;current&nbsp;category.&nbsp;cbf_rewind_saveframe&nbsp;makes&nbsp;the&nbsp;first&nbsp;<br>
saveframe&nbsp;in&nbsp;the&nbsp;current&nbsp;data&nbsp;block&nbsp;the&nbsp;current&nbsp;saveframe.&nbsp;<br>
cbf_rewind_blockitem&nbsp;makes&nbsp;the&nbsp;first&nbsp;blockitem&nbsp;(category&nbsp;or&nbsp;<br>
saveframe)&nbsp;in&nbsp;the&nbsp;current&nbsp;data&nbsp;block&nbsp;the&nbsp;current&nbsp;blockitem.<br>
If&nbsp;there&nbsp;are&nbsp;no&nbsp;categories,&nbsp;saveframes&nbsp;or&nbsp;blockitems&nbsp;the&nbsp;function&nbsp;<br>
returns&nbsp;CBF_NOTFOUND.<br>
The&nbsp;current&nbsp;column&nbsp;and&nbsp;row&nbsp;become&nbsp;undefined.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-rewind_column"><strong>rewind_column</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_rewind_column&nbsp;(cbf_handle&nbsp;handle);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_rewind_column&nbsp;makes&nbsp;the&nbsp;first&nbsp;column&nbsp;in&nbsp;the&nbsp;current&nbsp;category&nbsp;the&nbsp;<br>
current&nbsp;column.<br>
If&nbsp;there&nbsp;are&nbsp;no&nbsp;columns,&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_NOTFOUND.<br>
The&nbsp;current&nbsp;row&nbsp;is&nbsp;not&nbsp;affected.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-rewind_datablock"><strong>rewind_datablock</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_rewind_datablock&nbsp;(cbf_handle&nbsp;handle);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_rewind_datablock&nbsp;makes&nbsp;the&nbsp;first&nbsp;data&nbsp;block&nbsp;the&nbsp;current&nbsp;data&nbsp;<br>
block.<br>
If&nbsp;there&nbsp;are&nbsp;no&nbsp;data&nbsp;blocks,&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_NOTFOUND.<br>
The&nbsp;current&nbsp;category&nbsp;becomes&nbsp;undefined.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-rewind_row"><strong>rewind_row</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_rewind_row&nbsp;(cbf_handle&nbsp;handle);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_rewind_row&nbsp;makes&nbsp;the&nbsp;first&nbsp;row&nbsp;in&nbsp;the&nbsp;current&nbsp;category&nbsp;the&nbsp;<br>
current&nbsp;row.<br>
If&nbsp;there&nbsp;are&nbsp;no&nbsp;rows,&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_NOTFOUND.<br>
The&nbsp;current&nbsp;column&nbsp;is&nbsp;not&nbsp;affected.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-rewind_saveframe"><strong>rewind_saveframe</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_rewind_saveframe&nbsp;(cbf_handle&nbsp;handle);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_rewind_category&nbsp;makes&nbsp;the&nbsp;first&nbsp;category&nbsp;in&nbsp;the&nbsp;current&nbsp;data&nbsp;<br>
block&nbsp;the&nbsp;current&nbsp;category.&nbsp;cbf_rewind_saveframe&nbsp;makes&nbsp;the&nbsp;first&nbsp;<br>
saveframe&nbsp;in&nbsp;the&nbsp;current&nbsp;data&nbsp;block&nbsp;the&nbsp;current&nbsp;saveframe.&nbsp;<br>
cbf_rewind_blockitem&nbsp;makes&nbsp;the&nbsp;first&nbsp;blockitem&nbsp;(category&nbsp;or&nbsp;<br>
saveframe)&nbsp;in&nbsp;the&nbsp;current&nbsp;data&nbsp;block&nbsp;the&nbsp;current&nbsp;blockitem.<br>
If&nbsp;there&nbsp;are&nbsp;no&nbsp;categories,&nbsp;saveframes&nbsp;or&nbsp;blockitems&nbsp;the&nbsp;function&nbsp;<br>
returns&nbsp;CBF_NOTFOUND.<br>
The&nbsp;current&nbsp;column&nbsp;and&nbsp;row&nbsp;become&nbsp;undefined.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-row_number"><strong>row_number</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;Integer<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_row_number&nbsp;(cbf_handle&nbsp;handle,&nbsp;unsigned&nbsp;int&nbsp;*row);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_row_number&nbsp;sets&nbsp;*row&nbsp;to&nbsp;the&nbsp;number&nbsp;of&nbsp;the&nbsp;current&nbsp;row&nbsp;of&nbsp;the&nbsp;<br>
current&nbsp;category.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;row&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;row&nbsp;number.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-select_category"><strong>select_category</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;Integer<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_select_category&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;category);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_select_category&nbsp;selects&nbsp;category&nbsp;number&nbsp;category&nbsp;in&nbsp;the&nbsp;current&nbsp;<br>
data&nbsp;block&nbsp;as&nbsp;the&nbsp;current&nbsp;category.<br>
The&nbsp;first&nbsp;category&nbsp;is&nbsp;number&nbsp;0.<br>
The&nbsp;current&nbsp;column&nbsp;and&nbsp;row&nbsp;become&nbsp;undefined.<br>
If&nbsp;the&nbsp;category&nbsp;does&nbsp;not&nbsp;exist,&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_NOTFOUND.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;category&nbsp;&nbsp;&nbsp;Number&nbsp;of&nbsp;the&nbsp;category&nbsp;to&nbsp;select.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-select_column"><strong>select_column</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;Integer<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_select_column&nbsp;(cbf_handle&nbsp;handle,&nbsp;unsigned&nbsp;int&nbsp;column);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_select_column&nbsp;selects&nbsp;column&nbsp;number&nbsp;column&nbsp;in&nbsp;the&nbsp;current&nbsp;<br>
category&nbsp;as&nbsp;the&nbsp;current&nbsp;column.<br>
The&nbsp;first&nbsp;column&nbsp;is&nbsp;number&nbsp;0.<br>
The&nbsp;current&nbsp;row&nbsp;is&nbsp;not&nbsp;affected<br>
If&nbsp;the&nbsp;column&nbsp;does&nbsp;not&nbsp;exist,&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_NOTFOUND.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;column&nbsp;&nbsp;&nbsp;Number&nbsp;of&nbsp;the&nbsp;column&nbsp;to&nbsp;select.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-select_datablock"><strong>select_datablock</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;Integer<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_select_datablock&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;datablock);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_select_datablock&nbsp;selects&nbsp;data&nbsp;block&nbsp;number&nbsp;datablock&nbsp;as&nbsp;the&nbsp;<br>
current&nbsp;data&nbsp;block.<br>
The&nbsp;first&nbsp;data&nbsp;block&nbsp;is&nbsp;number&nbsp;0.<br>
If&nbsp;the&nbsp;data&nbsp;block&nbsp;does&nbsp;not&nbsp;exist,&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_NOTFOUND.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;datablock&nbsp;&nbsp;&nbsp;Number&nbsp;of&nbsp;the&nbsp;data&nbsp;block&nbsp;to&nbsp;<br>
select.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-select_row"><strong>select_row</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;Integer<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_select_row&nbsp;(cbf_handle&nbsp;handle,&nbsp;unsigned&nbsp;int&nbsp;row);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_select_row&nbsp;selects&nbsp;row&nbsp;number&nbsp;row&nbsp;in&nbsp;the&nbsp;current&nbsp;category&nbsp;as&nbsp;the&nbsp;<br>
current&nbsp;row.<br>
The&nbsp;first&nbsp;row&nbsp;is&nbsp;number&nbsp;0.<br>
The&nbsp;current&nbsp;column&nbsp;is&nbsp;not&nbsp;affected<br>
If&nbsp;the&nbsp;row&nbsp;does&nbsp;not&nbsp;exist,&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_NOTFOUND.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;row&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Number&nbsp;of&nbsp;the&nbsp;row&nbsp;to&nbsp;select.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_3d_image"><strong>set_3d_image</strong></a>(*args)</dt><dd><tt><a href="#cbf_handle_struct-set_3d_image">set_3d_image</a>(self,&nbsp;void&nbsp;?)</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_axis_setting"><strong>set_axis_setting</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;String&nbsp;axis_id,Float&nbsp;start,Float&nbsp;increment<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_set_axis_setting&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;reserved,&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char&nbsp;*axis_id,&nbsp;double&nbsp;start,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;increment);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_set_axis_setting&nbsp;sets&nbsp;the&nbsp;starting&nbsp;and&nbsp;increment&nbsp;values&nbsp;of&nbsp;the&nbsp;<br>
axis&nbsp;axis_id&nbsp;to&nbsp;start&nbsp;and&nbsp;increment.<br>
The&nbsp;parameter&nbsp;reserved&nbsp;is&nbsp;presently&nbsp;unused&nbsp;and&nbsp;should&nbsp;be&nbsp;set&nbsp;to&nbsp;0.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;reserved&nbsp;&nbsp;&nbsp;&nbsp;Unused.&nbsp;Any&nbsp;value&nbsp;other&nbsp;than&nbsp;0&nbsp;is&nbsp;<br>
invalid.&nbsp;axis_id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Axis&nbsp;id.&nbsp;start&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Start&nbsp;value.&nbsp;increment&nbsp;&nbsp;&nbsp;<br>
Increment&nbsp;value.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_bin_sizes"><strong>set_bin_sizes</strong></a>(*args)</dt><dd><tt><a href="#cbf_handle_struct-set_bin_sizes">set_bin_sizes</a>(self,&nbsp;void&nbsp;?)</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_category_root"><strong>set_category_root</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;String&nbsp;categoryname,String&nbsp;categoryroot<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_set_category_root&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char*&nbsp;&nbsp;&nbsp;&nbsp;categoryname_in,&nbsp;const&nbsp;char*categoryroot);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_find_category_root&nbsp;sets&nbsp;*categoryroot&nbsp;to&nbsp;the&nbsp;root&nbsp;category&nbsp;of&nbsp;<br>
which&nbsp;categoryname&nbsp;is&nbsp;an&nbsp;alias.&nbsp;cbf_set_category_root&nbsp;sets&nbsp;<br>
categoryname_in&nbsp;as&nbsp;an&nbsp;alias&nbsp;of&nbsp;categoryroot&nbsp;in&nbsp;the&nbsp;dictionary&nbsp;<br>
associated&nbsp;with&nbsp;handle,&nbsp;creating&nbsp;the&nbsp;dictionary&nbsp;if&nbsp;necessary.&nbsp;<br>
cbf_require_category_root&nbsp;sets&nbsp;*categoryroot&nbsp;to&nbsp;the&nbsp;root&nbsp;category&nbsp;of&nbsp;<br>
which&nbsp;categoryname&nbsp;is&nbsp;an&nbsp;alias,&nbsp;if&nbsp;there&nbsp;is&nbsp;one,&nbsp;or&nbsp;to&nbsp;the&nbsp;value&nbsp;of&nbsp;<br>
categoryname,&nbsp;if&nbsp;categoryname&nbsp;is&nbsp;not&nbsp;an&nbsp;alias.<br>
A&nbsp;returned&nbsp;categoryroot&nbsp;string&nbsp;must&nbsp;not&nbsp;be&nbsp;modified&nbsp;in&nbsp;any&nbsp;way.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;categoryname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;category&nbsp;name&nbsp;which&nbsp;<br>
may&nbsp;be&nbsp;an&nbsp;alias.&nbsp;categoryroot&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;pointer&nbsp;to&nbsp;a&nbsp;returned&nbsp;category&nbsp;<br>
root&nbsp;name.&nbsp;categoryroot_in&nbsp;&nbsp;&nbsp;input&nbsp;category&nbsp;root&nbsp;name.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_crystal_id"><strong>set_crystal_id</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;string<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_set_crystal_id&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char&nbsp;*crystal_id);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_set_crystal_id&nbsp;sets&nbsp;the&nbsp;"diffrn.crystal_id"&nbsp;entry&nbsp;to&nbsp;the&nbsp;ASCII&nbsp;<br>
value&nbsp;crystal_id.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;crystal_id&nbsp;&nbsp;&nbsp;ASCII&nbsp;value.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_datablockname"><strong>set_datablockname</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;string<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_set_datablockname&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char&nbsp;&nbsp;&nbsp;&nbsp;*datablockname);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_set_datablockname&nbsp;changes&nbsp;the&nbsp;name&nbsp;of&nbsp;the&nbsp;current&nbsp;data&nbsp;block&nbsp;to&nbsp;<br>
datablockname.&nbsp;cbf_set_saveframename&nbsp;changes&nbsp;the&nbsp;name&nbsp;of&nbsp;the&nbsp;current&nbsp;<br>
save&nbsp;frame&nbsp;to&nbsp;saveframename.<br>
If&nbsp;a&nbsp;data&nbsp;block&nbsp;or&nbsp;save&nbsp;frame&nbsp;with&nbsp;this&nbsp;name&nbsp;already&nbsp;exists&nbsp;<br>
(comparison&nbsp;is&nbsp;case-insensitive),&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_IDENTICAL.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;datablockname&nbsp;&nbsp;&nbsp;The&nbsp;new&nbsp;data&nbsp;block&nbsp;name.&nbsp;<br>
datablockname&nbsp;&nbsp;&nbsp;The&nbsp;new&nbsp;save&nbsp;frame&nbsp;name.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_datestamp"><strong>set_datestamp</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;int&nbsp;year,int&nbsp;month,int&nbsp;day,int&nbsp;hour,int&nbsp;minute,double&nbsp;second,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;timezone,Float&nbsp;precision<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_set_datestamp&nbsp;(cbf_handle&nbsp;handle,&nbsp;unsigned&nbsp;int&nbsp;reserved,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;&nbsp;&nbsp;&nbsp;year,&nbsp;int&nbsp;month,&nbsp;int&nbsp;day,&nbsp;int&nbsp;hour,&nbsp;int&nbsp;minute,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;second,&nbsp;int&nbsp;&nbsp;&nbsp;&nbsp;timezone,&nbsp;double&nbsp;precision);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_set_datestamp&nbsp;sets&nbsp;the&nbsp;collection&nbsp;timestamp&nbsp;in&nbsp;seconds&nbsp;since&nbsp;<br>
January&nbsp;1&nbsp;1970&nbsp;to&nbsp;the&nbsp;value&nbsp;specified&nbsp;by&nbsp;time.&nbsp;The&nbsp;timezone&nbsp;<br>
difference&nbsp;from&nbsp;UTC&nbsp;in&nbsp;minutes&nbsp;is&nbsp;set&nbsp;to&nbsp;timezone.&nbsp;If&nbsp;no&nbsp;timezone&nbsp;is&nbsp;<br>
desired,&nbsp;timezone&nbsp;should&nbsp;be&nbsp;CBF_NOTIM&nbsp;EZONE.&nbsp;The&nbsp;parameter&nbsp;reserved&nbsp;<br>
is&nbsp;presently&nbsp;unused&nbsp;and&nbsp;should&nbsp;be&nbsp;set&nbsp;to&nbsp;0.<br>
The&nbsp;precision&nbsp;of&nbsp;the&nbsp;new&nbsp;timestamp&nbsp;is&nbsp;specified&nbsp;by&nbsp;the&nbsp;value&nbsp;<br>
precision&nbsp;in&nbsp;seconds.&nbsp;If&nbsp;precision&nbsp;is&nbsp;0,&nbsp;the&nbsp;saved&nbsp;timestamp&nbsp;is&nbsp;<br>
assumed&nbsp;accurate&nbsp;to&nbsp;1&nbsp;second.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;reserved&nbsp;&nbsp;Unused.&nbsp;Any&nbsp;value&nbsp;other&nbsp;than&nbsp;0&nbsp;is&nbsp;<br>
invalid.&nbsp;time&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Timestamp&nbsp;in&nbsp;seconds&nbsp;since&nbsp;January&nbsp;1&nbsp;1970.&nbsp;<br>
timezone&nbsp;&nbsp;Timezone&nbsp;difference&nbsp;from&nbsp;UTC&nbsp;in&nbsp;minutes&nbsp;or&nbsp;CBF_NOTIMEZONE.&nbsp;<br>
precision&nbsp;Timestamp&nbsp;precision&nbsp;in&nbsp;seconds.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_dictionary"><strong>set_dictionary</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;CBFHandle&nbsp;dictionary<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_set_dictionary&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;cbf_handle&nbsp;dictionary_in);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_dictionary&nbsp;sets&nbsp;*dictionary&nbsp;to&nbsp;the&nbsp;handle&nbsp;of&nbsp;a&nbsp;CBF&nbsp;which&nbsp;has&nbsp;<br>
been&nbsp;associated&nbsp;with&nbsp;the&nbsp;CBF&nbsp;handle&nbsp;by&nbsp;cbf_set_dictionary.&nbsp;<br>
cbf_set_dictionary&nbsp;associates&nbsp;the&nbsp;CBF&nbsp;handle&nbsp;dictionary_in&nbsp;with&nbsp;<br>
handle&nbsp;as&nbsp;its&nbsp;dictionary.&nbsp;cbf_require_dictionary&nbsp;sets&nbsp;*dictionary&nbsp;to&nbsp;<br>
the&nbsp;handle&nbsp;of&nbsp;a&nbsp;CBF&nbsp;which&nbsp;has&nbsp;been&nbsp;associated&nbsp;with&nbsp;the&nbsp;CBF&nbsp;handle&nbsp;by&nbsp;<br>
cbf_set_dictionary&nbsp;or&nbsp;creates&nbsp;a&nbsp;new&nbsp;empty&nbsp;CBF&nbsp;and&nbsp;associates&nbsp;it&nbsp;with&nbsp;<br>
handle,&nbsp;returning&nbsp;the&nbsp;new&nbsp;handle&nbsp;in&nbsp;*dictionary.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;dictionary&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;CBF&nbsp;handle&nbsp;of&nbsp;<br>
dictionary.&nbsp;dictionary_in&nbsp;&nbsp;&nbsp;CBF&nbsp;handle&nbsp;of&nbsp;dcitionary.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_diffrn_id"><strong>set_diffrn_id</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;string<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_set_diffrn_id&nbsp;(cbf_handle&nbsp;handle,&nbsp;const&nbsp;char&nbsp;*diffrn_id);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_set_diffrn_id&nbsp;sets&nbsp;the&nbsp;"diffrn.id"&nbsp;entry&nbsp;of&nbsp;the&nbsp;current&nbsp;<br>
datablock&nbsp;to&nbsp;the&nbsp;ASCII&nbsp;value&nbsp;diffrn_id.<br>
This&nbsp;function&nbsp;also&nbsp;changes&nbsp;corresponding&nbsp;"diffrn_id"&nbsp;entries&nbsp;in&nbsp;the&nbsp;<br>
"diffrn_source",&nbsp;"diffrn_radiation",&nbsp;"diffrn_detector"&nbsp;and&nbsp;<br>
"diffrn_measurement"&nbsp;categories.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;diffrn_id&nbsp;&nbsp;&nbsp;ASCII&nbsp;value.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_divergence"><strong>set_divergence</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;Float&nbsp;div_x_source,Float&nbsp;div_y_source,Float&nbsp;div_x_y_source<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_set_divergence&nbsp;(cbf_handle&nbsp;handle,&nbsp;double&nbsp;div_x_source,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;&nbsp;&nbsp;&nbsp;div_y_source,&nbsp;double&nbsp;div_x_y_source);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_set_divergence&nbsp;sets&nbsp;the&nbsp;source&nbsp;divergence&nbsp;parameters&nbsp;to&nbsp;the&nbsp;<br>
values&nbsp;specified&nbsp;by&nbsp;div_x_source,&nbsp;div_y_source&nbsp;and&nbsp;div_x_y_source.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;div_x_source&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;New&nbsp;value&nbsp;of&nbsp;<br>
div_x_source.&nbsp;div_y_source&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;New&nbsp;value&nbsp;of&nbsp;div_y_source.&nbsp;<br>
div_x_y_source&nbsp;&nbsp;&nbsp;New&nbsp;value&nbsp;of&nbsp;div_x_y_source.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_doublevalue"><strong>set_doublevalue</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;String&nbsp;format,Float&nbsp;number<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_set_doublevalue&nbsp;(cbf_handle&nbsp;handle,&nbsp;const&nbsp;char&nbsp;*format,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;&nbsp;&nbsp;&nbsp;number);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_set_doublevalue&nbsp;sets&nbsp;the&nbsp;item&nbsp;at&nbsp;the&nbsp;current&nbsp;column&nbsp;and&nbsp;row&nbsp;to&nbsp;<br>
the&nbsp;floating-point&nbsp;value&nbsp;number&nbsp;written&nbsp;as&nbsp;an&nbsp;ASCII&nbsp;string&nbsp;with&nbsp;the&nbsp;<br>
format&nbsp;specified&nbsp;by&nbsp;format&nbsp;as&nbsp;appropriate&nbsp;for&nbsp;the&nbsp;printf&nbsp;function.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;format&nbsp;&nbsp;&nbsp;Format&nbsp;for&nbsp;the&nbsp;number.&nbsp;number&nbsp;&nbsp;&nbsp;<br>
Floating-point&nbsp;value.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_gain"><strong>set_gain</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;Float&nbsp;gain,Float&nbsp;gain_esd<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_set_gain&nbsp;(cbf_handle&nbsp;handle,&nbsp;unsigned&nbsp;int&nbsp;element_number,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;gain,&nbsp;double&nbsp;gain_esd);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_set_gain&nbsp;sets&nbsp;the&nbsp;gain&nbsp;of&nbsp;element&nbsp;number&nbsp;element_number&nbsp;to&nbsp;the&nbsp;<br>
values&nbsp;specified&nbsp;by&nbsp;gain&nbsp;and&nbsp;gain_esd.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;element_number&nbsp;&nbsp;&nbsp;The&nbsp;number&nbsp;of&nbsp;the&nbsp;detector&nbsp;<br>
element&nbsp;counting&nbsp;from&nbsp;0&nbsp;by&nbsp;order&nbsp;of&nbsp;appearance&nbsp;in&nbsp;the&nbsp;<br>
"diffrn_data_frame"&nbsp;category.&nbsp;gain&nbsp;&nbsp;&nbsp;New&nbsp;gain&nbsp;value.&nbsp;gain_esd&nbsp;&nbsp;&nbsp;New&nbsp;<br>
gain_esd&nbsp;value.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_image"><strong>set_image</strong></a>(*args)</dt><dd><tt><a href="#cbf_handle_struct-set_image">set_image</a>(self,&nbsp;void&nbsp;?)</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_integerarray"><strong>set_integerarray</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;int&nbsp;compression,int&nbsp;binary_id,(binary)&nbsp;String&nbsp;data,int&nbsp;elsize,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;elsigned,int&nbsp;elements<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_set_integerarray&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;compression,&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;binary_id,&nbsp;void&nbsp;*array,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;size_t&nbsp;elsize,&nbsp;int&nbsp;elsigned,&nbsp;size_t&nbsp;&nbsp;&nbsp;&nbsp;elements);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_set_integerarray&nbsp;sets&nbsp;the&nbsp;binary&nbsp;value&nbsp;of&nbsp;the&nbsp;item&nbsp;at&nbsp;the&nbsp;current&nbsp;<br>
column&nbsp;and&nbsp;row&nbsp;to&nbsp;an&nbsp;integer&nbsp;array.&nbsp;The&nbsp;array&nbsp;consists&nbsp;of&nbsp;elements&nbsp;<br>
elements&nbsp;of&nbsp;elsize&nbsp;bytes&nbsp;each,&nbsp;starting&nbsp;at&nbsp;array.&nbsp;The&nbsp;elements&nbsp;are&nbsp;<br>
signed&nbsp;if&nbsp;elsigned&nbsp;is&nbsp;non-0&nbsp;and&nbsp;unsigned&nbsp;otherwise.&nbsp;binary_id&nbsp;is&nbsp;the&nbsp;<br>
binary&nbsp;section&nbsp;identifier.&nbsp;cbf_set_realarray&nbsp;sets&nbsp;the&nbsp;binary&nbsp;value&nbsp;of&nbsp;<br>
the&nbsp;item&nbsp;at&nbsp;the&nbsp;current&nbsp;column&nbsp;and&nbsp;row&nbsp;to&nbsp;an&nbsp;integer&nbsp;array.&nbsp;The&nbsp;array&nbsp;<br>
consists&nbsp;of&nbsp;elements&nbsp;elements&nbsp;of&nbsp;elsize&nbsp;bytes&nbsp;each,&nbsp;starting&nbsp;at&nbsp;<br>
array.&nbsp;binary_id&nbsp;is&nbsp;the&nbsp;binary&nbsp;section&nbsp;identifier.<br>
The&nbsp;cbf_set_integerarray_wdims&nbsp;and&nbsp;cbf_set_realarray_wdims&nbsp;allow&nbsp;the&nbsp;<br>
data&nbsp;header&nbsp;values&nbsp;of&nbsp;byteorder,&nbsp;dim1,&nbsp;dim2,&nbsp;dim3&nbsp;and&nbsp;padding&nbsp;to&nbsp;be&nbsp;<br>
set&nbsp;to&nbsp;the&nbsp;data&nbsp;byte&nbsp;order,&nbsp;the&nbsp;fastest,&nbsp;second&nbsp;fastest&nbsp;and&nbsp;third&nbsp;<br>
fastest&nbsp;array&nbsp;dimensions&nbsp;and&nbsp;the&nbsp;size&nbsp;in&nbsp;byte&nbsp;of&nbsp;the&nbsp;post&nbsp;data&nbsp;<br>
padding&nbsp;to&nbsp;be&nbsp;used.<br>
The&nbsp;array&nbsp;will&nbsp;be&nbsp;compressed&nbsp;using&nbsp;the&nbsp;compression&nbsp;scheme&nbsp;specifed&nbsp;by&nbsp;<br>
compression.&nbsp;Currently,&nbsp;the&nbsp;available&nbsp;schemes&nbsp;are:<br>
CBF_CANONICAL&nbsp;&nbsp;&nbsp;Canonical-code&nbsp;compression&nbsp;(section&nbsp;3.3.1)&nbsp;CBF_PACKED&nbsp;<br>
&nbsp;&nbsp;CCP4-style&nbsp;packing&nbsp;(section&nbsp;3.3.2)&nbsp;CBF_PACKED_V2&nbsp;&nbsp;&nbsp;CCP4-style&nbsp;<br>
packing,&nbsp;version&nbsp;2&nbsp;(section&nbsp;3.3.2)&nbsp;CBF_BYTE_OFFSET&nbsp;&nbsp;&nbsp;Simple&nbsp;<br>
"byte_offset"&nbsp;compression.&nbsp;CBF_NONE&nbsp;&nbsp;&nbsp;No&nbsp;compression.&nbsp;NOTE:&nbsp;This&nbsp;<br>
scheme&nbsp;is&nbsp;by&nbsp;far&nbsp;the&nbsp;slowest&nbsp;of&nbsp;the&nbsp;four&nbsp;and&nbsp;uses&nbsp;much&nbsp;more&nbsp;disk&nbsp;<br>
space.&nbsp;It&nbsp;is&nbsp;intended&nbsp;for&nbsp;routine&nbsp;use&nbsp;with&nbsp;small&nbsp;arrays&nbsp;only.&nbsp;With&nbsp;<br>
large&nbsp;arrays&nbsp;(like&nbsp;images)&nbsp;it&nbsp;should&nbsp;be&nbsp;used&nbsp;only&nbsp;for&nbsp;debugging.<br>
The&nbsp;values&nbsp;compressed&nbsp;are&nbsp;limited&nbsp;to&nbsp;64&nbsp;bits.&nbsp;If&nbsp;any&nbsp;element&nbsp;in&nbsp;the&nbsp;<br>
array&nbsp;is&nbsp;larger&nbsp;than&nbsp;64&nbsp;bits,&nbsp;the&nbsp;value&nbsp;compressed&nbsp;is&nbsp;the&nbsp;nearest&nbsp;<br>
64-bit&nbsp;value.</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_integerarray_wdims"><strong>set_integerarray_wdims</strong></a>(*args)</dt><dd><tt><a href="#cbf_handle_struct-set_integerarray_wdims">set_integerarray_wdims</a>(self,&nbsp;void&nbsp;?)</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_integervalue"><strong>set_integervalue</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;int&nbsp;number<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_set_integervalue&nbsp;(cbf_handle&nbsp;handle,&nbsp;int&nbsp;number);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_set_integervalue&nbsp;sets&nbsp;the&nbsp;item&nbsp;at&nbsp;the&nbsp;current&nbsp;column&nbsp;and&nbsp;row&nbsp;to&nbsp;<br>
the&nbsp;integer&nbsp;value&nbsp;number&nbsp;written&nbsp;as&nbsp;a&nbsp;decimal&nbsp;ASCII&nbsp;string.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;number&nbsp;&nbsp;&nbsp;Integer&nbsp;value.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_integration_time"><strong>set_integration_time</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;Float&nbsp;time<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_set_integration_time&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;&nbsp;&nbsp;&nbsp;reserved,&nbsp;double&nbsp;time);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_set_integration_time&nbsp;sets&nbsp;the&nbsp;integration&nbsp;time&nbsp;in&nbsp;seconds&nbsp;to&nbsp;the&nbsp;<br>
value&nbsp;specified&nbsp;by&nbsp;time.&nbsp;The&nbsp;parameter&nbsp;reserved&nbsp;is&nbsp;presently&nbsp;unused&nbsp;<br>
and&nbsp;should&nbsp;be&nbsp;set&nbsp;to&nbsp;0.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;reserved&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Unused.&nbsp;Any&nbsp;value&nbsp;<br>
other&nbsp;than&nbsp;0&nbsp;is&nbsp;invalid.&nbsp;time&nbsp;Integration&nbsp;&nbsp;&nbsp;time&nbsp;in&nbsp;seconds.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_orientation_matrix"><strong>set_orientation_matrix</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;Float&nbsp;matrix_0,Float&nbsp;matrix_1,Float&nbsp;matrix_2,Float&nbsp;matrix_3,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Float&nbsp;matrix_4,Float&nbsp;matrix_5,Float&nbsp;matrix_6,Float&nbsp;matrix_7,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Float&nbsp;matrix_8<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_set_orientation_matrix&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;&nbsp;&nbsp;&nbsp;ub_matrix[9]);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_orientation_matrix&nbsp;sets&nbsp;ub_matrix&nbsp;to&nbsp;point&nbsp;to&nbsp;the&nbsp;array&nbsp;of&nbsp;<br>
orientation&nbsp;matrix&nbsp;entries&nbsp;in&nbsp;the&nbsp;"diffrn"&nbsp;category&nbsp;in&nbsp;the&nbsp;order&nbsp;of&nbsp;<br>
columns:<br>
"UB[1][1]"&nbsp;"UB[1][2]"&nbsp;"UB[1][3]"&nbsp;"UB[2][1]"&nbsp;"UB[2][2]"&nbsp;<br>
"UB[2][3]"&nbsp;"UB[3][1]"&nbsp;"UB[3][2]"&nbsp;"UB[3][3]"<br>
cbf_set_orientation_matrix&nbsp;sets&nbsp;the&nbsp;values&nbsp;in&nbsp;the&nbsp;"diffrn"&nbsp;category&nbsp;<br>
to&nbsp;the&nbsp;values&nbsp;pointed&nbsp;to&nbsp;by&nbsp;ub_matrix.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;ubmatric&nbsp;&nbsp;&nbsp;Source&nbsp;or&nbsp;destination&nbsp;array&nbsp;of&nbsp;9&nbsp;<br>
doubles&nbsp;giving&nbsp;the&nbsp;orientation&nbsp;matrix&nbsp;parameters.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_overload"><strong>set_overload</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;Integer&nbsp;element_number,Float&nbsp;overload<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_set_overload&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;element_number,&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;overload);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_set_overload&nbsp;sets&nbsp;the&nbsp;overload&nbsp;value&nbsp;of&nbsp;element&nbsp;number&nbsp;<br>
element_number&nbsp;to&nbsp;overload.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;element_number&nbsp;&nbsp;&nbsp;The&nbsp;number&nbsp;of&nbsp;the&nbsp;detector&nbsp;<br>
element&nbsp;counting&nbsp;from&nbsp;0&nbsp;by&nbsp;order&nbsp;of&nbsp;appearance&nbsp;in&nbsp;the&nbsp;<br>
"diffrn_data_frame"&nbsp;category.&nbsp;overload&nbsp;&nbsp;&nbsp;New&nbsp;overload&nbsp;value.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_pixel_size"><strong>set_pixel_size</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;Int&nbsp;element_number,Int&nbsp;axis_number,Float&nbsp;pixel&nbsp;size<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_set_pixel_size&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;&nbsp;&nbsp;&nbsp;element_number,&nbsp;unsigned&nbsp;int&nbsp;axis_number,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;psize);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_set_pixel_size&nbsp;sets&nbsp;the&nbsp;item&nbsp;in&nbsp;the&nbsp;&amp;quote;size&amp;quote;&nbsp;column&nbsp;of&nbsp;<br>
the&nbsp;"array_structure_list"&nbsp;category&nbsp;at&nbsp;the&nbsp;row&nbsp;which&nbsp;matches&nbsp;axis&nbsp;<br>
axis_number&nbsp;of&nbsp;the&nbsp;detector&nbsp;element&nbsp;element_number&nbsp;converting&nbsp;the&nbsp;<br>
double&nbsp;pixel&nbsp;size&nbsp;psize&nbsp;from&nbsp;meters&nbsp;to&nbsp;millimeters&nbsp;in&nbsp;storing&nbsp;it&nbsp;in&nbsp;<br>
the&nbsp;"size"&nbsp;column&nbsp;for&nbsp;the&nbsp;axis&nbsp;axis_number&nbsp;of&nbsp;the&nbsp;detector&nbsp;element&nbsp;<br>
element_number.&nbsp;The&nbsp;axis_number&nbsp;is&nbsp;numbered&nbsp;from&nbsp;1,&nbsp;starting&nbsp;with&nbsp;the&nbsp;<br>
fastest&nbsp;axis.<br>
If&nbsp;the&nbsp;"array_structure_list"&nbsp;category&nbsp;does&nbsp;not&nbsp;already&nbsp;exist,&nbsp;it&nbsp;<br>
is&nbsp;created.<br>
If&nbsp;the&nbsp;appropriate&nbsp;row&nbsp;in&nbsp;the&nbsp;"array_structure_list"&nbsp;catgeory&nbsp;does&nbsp;<br>
not&nbsp;already&nbsp;exist,&nbsp;it&nbsp;is&nbsp;created.<br>
If&nbsp;the&nbsp;pixel&nbsp;size&nbsp;is&nbsp;not&nbsp;given&nbsp;explcitly&nbsp;in&nbsp;the&nbsp;"array_element_size&nbsp;<br>
category",&nbsp;the&nbsp;function&nbsp;returns&nbsp;CBF_NOTFOUND.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;element_number&nbsp;&nbsp;&nbsp;The&nbsp;number&nbsp;of&nbsp;the&nbsp;detector&nbsp;<br>
element&nbsp;counting&nbsp;from&nbsp;0&nbsp;by&nbsp;order&nbsp;of&nbsp;appearance&nbsp;in&nbsp;the&nbsp;<br>
"diffrn_data_frame"&nbsp;category.&nbsp;axis_number&nbsp;&nbsp;&nbsp;The&nbsp;number&nbsp;of&nbsp;the&nbsp;axis,&nbsp;<br>
fastest&nbsp;first,&nbsp;starting&nbsp;from&nbsp;1.</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_polarization"><strong>set_polarization</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;Float&nbsp;polarizn_source_ratio,Float&nbsp;polarizn_source_norm<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_set_polarization&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;&nbsp;&nbsp;&nbsp;polarizn_source_ratio,&nbsp;double&nbsp;polarizn_source_norm);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_set_polarization&nbsp;sets&nbsp;the&nbsp;source&nbsp;polarization&nbsp;to&nbsp;the&nbsp;values&nbsp;<br>
specified&nbsp;by&nbsp;polarizn_source_ratio&nbsp;and&nbsp;polarizn_source_norm.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;polarizn_source_ratio&nbsp;&nbsp;&nbsp;New&nbsp;value&nbsp;<br>
of&nbsp;polarizn_source_ratio.&nbsp;polarizn_source_norm&nbsp;&nbsp;&nbsp;&nbsp;New&nbsp;value&nbsp;of&nbsp;<br>
polarizn_source_norm.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_real_3d_image"><strong>set_real_3d_image</strong></a>(*args)</dt><dd><tt><a href="#cbf_handle_struct-set_real_3d_image">set_real_3d_image</a>(self,&nbsp;void&nbsp;?)</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_real_image"><strong>set_real_image</strong></a>(*args)</dt><dd><tt><a href="#cbf_handle_struct-set_real_image">set_real_image</a>(self,&nbsp;void&nbsp;?)</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_realarray"><strong>set_realarray</strong></a>(*args)</dt><dd><tt><a href="#cbf_handle_struct-set_realarray">set_realarray</a>(self,&nbsp;void&nbsp;?)</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_realarray_wdims"><strong>set_realarray_wdims</strong></a>(*args)</dt><dd><tt><a href="#cbf_handle_struct-set_realarray_wdims">set_realarray_wdims</a>(self,&nbsp;void&nbsp;?)</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_reciprocal_cell"><strong>set_reciprocal_cell</strong></a>(*args)</dt><dd><tt><a href="#cbf_handle_struct-set_reciprocal_cell">set_reciprocal_cell</a>(self,&nbsp;void&nbsp;?)</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_tag_category"><strong>set_tag_category</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;String&nbsp;tagname,String&nbsp;categoryname_in<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_set_tag_category&nbsp;(cbf_handle&nbsp;handle,&nbsp;const&nbsp;char*&nbsp;tagname,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char*&nbsp;categoryname_in);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_find_tag_category&nbsp;sets&nbsp;categoryname&nbsp;to&nbsp;the&nbsp;category&nbsp;associated&nbsp;<br>
with&nbsp;tagname&nbsp;in&nbsp;the&nbsp;dictionary&nbsp;associated&nbsp;with&nbsp;handle.&nbsp;<br>
cbf_set_tag_category&nbsp;upddates&nbsp;the&nbsp;dictionary&nbsp;associated&nbsp;with&nbsp;handle&nbsp;<br>
to&nbsp;indicated&nbsp;that&nbsp;tagname&nbsp;is&nbsp;in&nbsp;category&nbsp;categoryname_in.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;tagname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;tag&nbsp;name.&nbsp;<br>
categoryname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;pointer&nbsp;to&nbsp;a&nbsp;returned&nbsp;category&nbsp;name.&nbsp;<br>
categoryname_in&nbsp;&nbsp;&nbsp;input&nbsp;category&nbsp;name.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_tag_root"><strong>set_tag_root</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;String&nbsp;tagname,String&nbsp;tagroot_in<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_set_tag_root&nbsp;(cbf_handle&nbsp;handle,&nbsp;const&nbsp;char*&nbsp;tagname,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;&nbsp;&nbsp;&nbsp;char*tagroot_in);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_find_tag_root&nbsp;sets&nbsp;*tagroot&nbsp;to&nbsp;the&nbsp;root&nbsp;tag&nbsp;of&nbsp;which&nbsp;tagname&nbsp;is&nbsp;<br>
an&nbsp;alias.&nbsp;cbf_set_tag_root&nbsp;sets&nbsp;tagname&nbsp;as&nbsp;an&nbsp;alias&nbsp;of&nbsp;tagroot_in&nbsp;in&nbsp;<br>
the&nbsp;dictionary&nbsp;associated&nbsp;with&nbsp;handle,&nbsp;creating&nbsp;the&nbsp;dictionary&nbsp;if&nbsp;<br>
necessary.&nbsp;cbf_require_tag_root&nbsp;sets&nbsp;*tagroot&nbsp;to&nbsp;the&nbsp;root&nbsp;tag&nbsp;of&nbsp;<br>
which&nbsp;tagname&nbsp;is&nbsp;an&nbsp;alias,&nbsp;if&nbsp;there&nbsp;is&nbsp;one,&nbsp;or&nbsp;to&nbsp;the&nbsp;value&nbsp;of&nbsp;<br>
tagname,&nbsp;if&nbsp;tagname&nbsp;is&nbsp;not&nbsp;an&nbsp;alias.<br>
A&nbsp;returned&nbsp;tagroot&nbsp;string&nbsp;must&nbsp;not&nbsp;be&nbsp;modified&nbsp;in&nbsp;any&nbsp;way.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;tagname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;tag&nbsp;name&nbsp;which&nbsp;may&nbsp;be&nbsp;an&nbsp;alias.&nbsp;<br>
tagroot&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;pointer&nbsp;to&nbsp;a&nbsp;returned&nbsp;tag&nbsp;root&nbsp;name.&nbsp;tagroot_in&nbsp;&nbsp;&nbsp;input&nbsp;<br>
tag&nbsp;root&nbsp;name.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_timestamp"><strong>set_timestamp</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;Float&nbsp;time,Integer&nbsp;timezone,Float&nbsp;precision<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_set_timestamp&nbsp;(cbf_handle&nbsp;handle,&nbsp;unsigned&nbsp;int&nbsp;reserved,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;time,&nbsp;int&nbsp;timezone,&nbsp;double&nbsp;precision);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_set_timestamp&nbsp;sets&nbsp;the&nbsp;collection&nbsp;timestamp&nbsp;in&nbsp;seconds&nbsp;since&nbsp;<br>
January&nbsp;1&nbsp;1970&nbsp;to&nbsp;the&nbsp;value&nbsp;specified&nbsp;by&nbsp;time.&nbsp;The&nbsp;timezone&nbsp;<br>
difference&nbsp;from&nbsp;UTC&nbsp;in&nbsp;minutes&nbsp;is&nbsp;set&nbsp;to&nbsp;timezone.&nbsp;If&nbsp;no&nbsp;timezone&nbsp;is&nbsp;<br>
desired,&nbsp;timezone&nbsp;should&nbsp;be&nbsp;CBF_NOTIM&nbsp;EZONE.&nbsp;The&nbsp;parameter&nbsp;reserved&nbsp;<br>
is&nbsp;presently&nbsp;unused&nbsp;and&nbsp;should&nbsp;be&nbsp;set&nbsp;to&nbsp;0.<br>
The&nbsp;precision&nbsp;of&nbsp;the&nbsp;new&nbsp;timestamp&nbsp;is&nbsp;specified&nbsp;by&nbsp;the&nbsp;value&nbsp;<br>
precision&nbsp;in&nbsp;seconds.&nbsp;If&nbsp;precision&nbsp;is&nbsp;0,&nbsp;the&nbsp;saved&nbsp;timestamp&nbsp;is&nbsp;<br>
assumed&nbsp;accurate&nbsp;to&nbsp;1&nbsp;second.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;reserved&nbsp;&nbsp;&nbsp;Unused.&nbsp;Any&nbsp;value&nbsp;other&nbsp;than&nbsp;0&nbsp;is&nbsp;<br>
invalid.&nbsp;time&nbsp;&nbsp;&nbsp;Timestamp&nbsp;in&nbsp;seconds&nbsp;since&nbsp;January&nbsp;1&nbsp;1970.&nbsp;timezone&nbsp;&nbsp;&nbsp;<br>
Timezone&nbsp;difference&nbsp;from&nbsp;UTC&nbsp;in&nbsp;minutes&nbsp;or&nbsp;CBF_NOTIMEZONE.&nbsp;precision&nbsp;&nbsp;<br>
&nbsp;Timestamp&nbsp;precision&nbsp;in&nbsp;seconds.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_typeofvalue"><strong>set_typeofvalue</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;string<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_set_typeofvalue&nbsp;(cbf_handle&nbsp;handle,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;const&nbsp;char&nbsp;*typeofvalue);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_set_typeofvalue&nbsp;sets&nbsp;the&nbsp;type&nbsp;of&nbsp;the&nbsp;item&nbsp;at&nbsp;the&nbsp;current&nbsp;column&nbsp;<br>
and&nbsp;row&nbsp;to&nbsp;the&nbsp;type&nbsp;specified&nbsp;by&nbsp;the&nbsp;ASCII&nbsp;character&nbsp;string&nbsp;given&nbsp;by&nbsp;<br>
typeofvalue.&nbsp;The&nbsp;strings&nbsp;that&nbsp;may&nbsp;be&nbsp;used&nbsp;are&nbsp;"null"&nbsp;for&nbsp;a&nbsp;null&nbsp;<br>
value&nbsp;indicated&nbsp;by&nbsp;a&nbsp;"."&nbsp;or&nbsp;a&nbsp;"?",&nbsp;"word"&nbsp;for&nbsp;an&nbsp;unquoted&nbsp;<br>
string,&nbsp;"dblq"&nbsp;for&nbsp;a&nbsp;double-quoted&nbsp;string,&nbsp;"sglq"&nbsp;for&nbsp;a&nbsp;<br>
single-quoted&nbsp;string,&nbsp;and&nbsp;"text"&nbsp;for&nbsp;a&nbsp;semicolon-quoted&nbsp;text&nbsp;field.&nbsp;<br>
Not&nbsp;all&nbsp;types&nbsp;may&nbsp;be&nbsp;used&nbsp;for&nbsp;all&nbsp;values.&nbsp;No&nbsp;changes&nbsp;may&nbsp;be&nbsp;made&nbsp;to&nbsp;<br>
the&nbsp;type&nbsp;of&nbsp;binary&nbsp;values.&nbsp;You&nbsp;may&nbsp;not&nbsp;set&nbsp;the&nbsp;type&nbsp;of&nbsp;a&nbsp;string&nbsp;that&nbsp;<br>
contains&nbsp;a&nbsp;single&nbsp;quote&nbsp;followed&nbsp;by&nbsp;a&nbsp;blank&nbsp;or&nbsp;a&nbsp;tab&nbsp;or&nbsp;which&nbsp;<br>
contains&nbsp;multiple&nbsp;lines&nbsp;to&nbsp;"sglq".&nbsp;You&nbsp;may&nbsp;not&nbsp;set&nbsp;the&nbsp;type&nbsp;of&nbsp;a&nbsp;<br>
string&nbsp;that&nbsp;contains&nbsp;a&nbsp;double&nbsp;quote&nbsp;followed&nbsp;by&nbsp;a&nbsp;blank&nbsp;or&nbsp;a&nbsp;tab&nbsp;or&nbsp;<br>
which&nbsp;contains&nbsp;multiple&nbsp;lines&nbsp;to&nbsp;"dblq".<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;typeofvalue&nbsp;&nbsp;&nbsp;ASCII&nbsp;string&nbsp;for&nbsp;desired&nbsp;type&nbsp;<br>
of&nbsp;value.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_unit_cell"><strong>set_unit_cell</strong></a>(*args)</dt><dd><tt><a href="#cbf_handle_struct-set_unit_cell">set_unit_cell</a>(self,&nbsp;void&nbsp;?)</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_value"><strong>set_value</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;string<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_set_value&nbsp;(cbf_handle&nbsp;handle,&nbsp;const&nbsp;char&nbsp;*value);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_set_value&nbsp;sets&nbsp;the&nbsp;item&nbsp;at&nbsp;the&nbsp;current&nbsp;column&nbsp;and&nbsp;row&nbsp;to&nbsp;the&nbsp;<br>
ASCII&nbsp;value&nbsp;value.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ASCII&nbsp;value.&nbsp;defaultvalue&nbsp;&nbsp;&nbsp;<br>
default&nbsp;ASCII&nbsp;value.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-set_wavelength"><strong>set_wavelength</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;double&nbsp;wavelength<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_set_wavelength&nbsp;(cbf_handle&nbsp;handle,&nbsp;double&nbsp;wavelength);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_set_wavelength&nbsp;sets&nbsp;the&nbsp;current&nbsp;wavelength&nbsp;in&nbsp;Angstrom&nbsp;to&nbsp;<br>
wavelength.<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;wavelength&nbsp;&nbsp;&nbsp;Wavelength&nbsp;in&nbsp;Angstrom.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-write_file"><strong>write_file</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;String&nbsp;filename,Integer&nbsp;ciforcbf,Integer&nbsp;Headers,Integer&nbsp;encoding<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_write_file&nbsp;(cbf_handle&nbsp;handle,&nbsp;FILE&nbsp;*file,&nbsp;int&nbsp;readable,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;&nbsp;&nbsp;&nbsp;ciforcbf,&nbsp;int&nbsp;headers,&nbsp;int&nbsp;encoding);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_write_file&nbsp;writes&nbsp;the&nbsp;CBF&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;specified&nbsp;by&nbsp;handle&nbsp;into&nbsp;the&nbsp;<br>
file&nbsp;file,&nbsp;following&nbsp;CIF&nbsp;1.0&nbsp;conventions&nbsp;of&nbsp;80&nbsp;character&nbsp;lines.&nbsp;<br>
cbf_write_widefile&nbsp;writes&nbsp;the&nbsp;CBF&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;specified&nbsp;by&nbsp;handle&nbsp;into&nbsp;the&nbsp;<br>
file&nbsp;file,&nbsp;following&nbsp;CIF&nbsp;1.1&nbsp;conventions&nbsp;of&nbsp;2048&nbsp;character&nbsp;lines.&nbsp;A&nbsp;<br>
warning&nbsp;is&nbsp;issued&nbsp;to&nbsp;stderr&nbsp;for&nbsp;ascii&nbsp;lines&nbsp;over&nbsp;the&nbsp;limit,&nbsp;and&nbsp;an&nbsp;<br>
attempt&nbsp;is&nbsp;made&nbsp;to&nbsp;fold&nbsp;lines&nbsp;to&nbsp;fit.&nbsp;No&nbsp;test&nbsp;is&nbsp;performed&nbsp;on&nbsp;binary&nbsp;<br>
sections.<br>
If&nbsp;a&nbsp;dictionary&nbsp;has&nbsp;been&nbsp;provided,&nbsp;aliases&nbsp;will&nbsp;be&nbsp;applied&nbsp;on&nbsp;output.<br>
Unlike&nbsp;cbf_read_file,&nbsp;the&nbsp;file&nbsp;does&nbsp;not&nbsp;have&nbsp;to&nbsp;be&nbsp;random-access.<br>
If&nbsp;the&nbsp;file&nbsp;is&nbsp;random-access&nbsp;and&nbsp;readable,&nbsp;readable&nbsp;can&nbsp;be&nbsp;set&nbsp;to&nbsp;<br>
non-0&nbsp;to&nbsp;indicate&nbsp;to&nbsp;CBFlib&nbsp;that&nbsp;the&nbsp;file&nbsp;can&nbsp;be&nbsp;used&nbsp;as&nbsp;a&nbsp;buffer&nbsp;to&nbsp;<br>
conserve&nbsp;disk&nbsp;space.&nbsp;If&nbsp;the&nbsp;file&nbsp;is&nbsp;not&nbsp;random-access&nbsp;or&nbsp;not&nbsp;<br>
readable,&nbsp;readable&nbsp;must&nbsp;be&nbsp;0.<br>
If&nbsp;readable&nbsp;is&nbsp;non-0,&nbsp;CBFlib&nbsp;will&nbsp;close&nbsp;the&nbsp;file&nbsp;when&nbsp;it&nbsp;is&nbsp;no&nbsp;longer&nbsp;<br>
required,&nbsp;otherwise&nbsp;this&nbsp;is&nbsp;the&nbsp;responsibility&nbsp;of&nbsp;the&nbsp;program.<br>
ciforcbf&nbsp;selects&nbsp;the&nbsp;format&nbsp;in&nbsp;which&nbsp;the&nbsp;binary&nbsp;sections&nbsp;are&nbsp;written:<br>
CIF&nbsp;&nbsp;&nbsp;Write&nbsp;an&nbsp;imgCIF&nbsp;file.&nbsp;CBF&nbsp;&nbsp;&nbsp;Write&nbsp;a&nbsp;CBF&nbsp;file&nbsp;(default).<br>
headers&nbsp;selects&nbsp;the&nbsp;type&nbsp;of&nbsp;header&nbsp;used&nbsp;in&nbsp;CBF&nbsp;binary&nbsp;sections&nbsp;and&nbsp;<br>
selects&nbsp;whether&nbsp;message&nbsp;digests&nbsp;are&nbsp;generated.&nbsp;The&nbsp;value&nbsp;of&nbsp;headers&nbsp;<br>
can&nbsp;be&nbsp;a&nbsp;logical&nbsp;OR&nbsp;of&nbsp;any&nbsp;of:<br>
MIME_HEADERS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Use&nbsp;MIME-type&nbsp;headers&nbsp;(default).&nbsp;MIME_NOHEADERS&nbsp;&nbsp;&nbsp;<br>
Use&nbsp;a&nbsp;simple&nbsp;ASCII&nbsp;headers.&nbsp;MSG_DIGEST&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Generate&nbsp;message&nbsp;digests&nbsp;<br>
for&nbsp;binary&nbsp;data&nbsp;validation.&nbsp;MSG_NODIGEST&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Do&nbsp;not&nbsp;generate&nbsp;message&nbsp;<br>
digests&nbsp;(default).<br>
encoding&nbsp;selects&nbsp;the&nbsp;type&nbsp;of&nbsp;encoding&nbsp;used&nbsp;for&nbsp;binary&nbsp;sections&nbsp;and&nbsp;<br>
the&nbsp;type&nbsp;of&nbsp;line-termination&nbsp;in&nbsp;imgCIF&nbsp;files.&nbsp;The&nbsp;value&nbsp;can&nbsp;be&nbsp;a&nbsp;<br>
logical&nbsp;OR&nbsp;of&nbsp;any&nbsp;of:<br>
ENC_BASE64&nbsp;&nbsp;&nbsp;Use&nbsp;BASE64&nbsp;encoding&nbsp;(default).&nbsp;ENC_QP&nbsp;&nbsp;&nbsp;Use&nbsp;<br>
QUOTED-PRINTABLE&nbsp;encoding.&nbsp;ENC_BASE8&nbsp;&nbsp;&nbsp;Use&nbsp;BASE8&nbsp;(octal)&nbsp;encoding.&nbsp;<br>
ENC_BASE10&nbsp;&nbsp;&nbsp;Use&nbsp;BASE10&nbsp;(decimal)&nbsp;encoding.&nbsp;ENC_BASE16&nbsp;&nbsp;&nbsp;Use&nbsp;BASE16&nbsp;<br>
(hexadecimal)&nbsp;encoding.&nbsp;ENC_FORWARD&nbsp;&nbsp;&nbsp;For&nbsp;BASE8,&nbsp;BASE10&nbsp;or&nbsp;BASE16&nbsp;<br>
encoding,&nbsp;map&nbsp;bytes&nbsp;to&nbsp;words&nbsp;forward&nbsp;(1234)&nbsp;(default&nbsp;on&nbsp;little-endian&nbsp;<br>
machines).&nbsp;ENC_BACKWARD&nbsp;&nbsp;&nbsp;Map&nbsp;bytes&nbsp;to&nbsp;words&nbsp;backward&nbsp;(4321)&nbsp;(default&nbsp;<br>
on&nbsp;big-endian&nbsp;machines).&nbsp;ENC_CRTERM&nbsp;&nbsp;&nbsp;Terminate&nbsp;lines&nbsp;with&nbsp;CR.&nbsp;<br>
ENC_LFTERM&nbsp;&nbsp;&nbsp;Terminate&nbsp;lines&nbsp;with&nbsp;LF&nbsp;(default).<br>
ARGUMENTS<br>
handle&nbsp;&nbsp;&nbsp;CBF&nbsp;handle.&nbsp;file&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;a&nbsp;file&nbsp;descriptor.&nbsp;readable&nbsp;&nbsp;&nbsp;<br>
If&nbsp;non-0:&nbsp;this&nbsp;file&nbsp;is&nbsp;random-access&nbsp;and&nbsp;readable&nbsp;and&nbsp;can&nbsp;be&nbsp;used&nbsp;as&nbsp;<br>
a&nbsp;buffer.&nbsp;ciforcbf&nbsp;&nbsp;&nbsp;Selects&nbsp;the&nbsp;format&nbsp;in&nbsp;which&nbsp;the&nbsp;binary&nbsp;sections&nbsp;<br>
are&nbsp;written&nbsp;(CIF/CBF).&nbsp;headers&nbsp;&nbsp;&nbsp;Selects&nbsp;the&nbsp;type&nbsp;of&nbsp;header&nbsp;in&nbsp;CBF&nbsp;<br>
binary&nbsp;sections&nbsp;and&nbsp;message&nbsp;digest&nbsp;generation.&nbsp;encoding&nbsp;&nbsp;&nbsp;Selects&nbsp;the&nbsp;<br>
type&nbsp;of&nbsp;encoding&nbsp;used&nbsp;for&nbsp;binary&nbsp;sections&nbsp;and&nbsp;the&nbsp;type&nbsp;of&nbsp;<br>
line-termination&nbsp;in&nbsp;imgCIF&nbsp;files.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.<br>
SEE&nbsp;ALSO</tt></dd></dl>

<dl><dt><a name="cbf_handle_struct-write_widefile"><strong>write_widefile</strong></a>(*args)</dt><dd><tt><a href="#cbf_handle_struct-write_widefile">write_widefile</a>(self,&nbsp;void&nbsp;?)</tt></dd></dl>

<hr>
Properties defined here:<br>
<dl><dt><strong>node</strong></dt>
<dd><dl><dt><a name="-<em>get</em>"><strong><em>get</em></strong></a> = cbf_handle_struct_node_get(...)</dt></dl>
</dd>
<dd><dl><dt><a name="-<em>set</em>"><strong><em>set</em></strong></a> = cbf_handle_struct_node_set(...)</dt></dl>
</dd>
</dl>
<dl><dt><strong>row</strong></dt>
<dd><dl><dt><a name="-<em>get</em>"><strong><em>get</em></strong></a> = cbf_handle_struct_row_get(...)</dt></dl>
</dd>
<dd><dl><dt><a name="-<em>set</em>"><strong><em>set</em></strong></a> = cbf_handle_struct_row_set(...)</dt></dl>
</dd>
</dl>
<dl><dt><strong>search_row</strong></dt>
<dd><dl><dt><a name="-<em>get</em>"><strong><em>get</em></strong></a> = cbf_handle_struct_search_row_get(...)</dt></dl>
</dd>
<dd><dl><dt><a name="-<em>set</em>"><strong><em>set</em></strong></a> = cbf_handle_struct_search_row_set(...)</dt></dl>
</dd>
</dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>__dict__</strong> = &lt;dictproxy object&gt;<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dl>

<dl><dt><strong>__swig_destroy__</strong> = &lt;built-in function delete_cbf_handle_struct&gt;</dl>

<dl><dt><strong>__swig_getmethods__</strong> = {'node': &lt;built-in function cbf_handle_struct_node_get&gt;, 'row': &lt;built-in function cbf_handle_struct_row_get&gt;, 'search_row': &lt;built-in function cbf_handle_struct_search_row_get&gt;}</dl>

<dl><dt><strong>__swig_setmethods__</strong> = {'node': &lt;built-in function cbf_handle_struct_node_set&gt;, 'row': &lt;built-in function cbf_handle_struct_row_set&gt;, 'search_row': &lt;built-in function cbf_handle_struct_search_row_set&gt;}</dl>

<dl><dt><strong>__weakref__</strong> = &lt;attribute '__weakref__' of 'cbf_handle_struct' objects&gt;<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;(if&nbsp;defined)</tt></dl>

</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="cbf_positioner_struct">class <strong>cbf_positioner_struct</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
    
<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><strong>__del__</strong> <em>lambda</em> self</dt></dl>

<dl><dt><strong>__getattr__</strong> <em>lambda</em> self, name</dt></dl>

<dl><dt><a name="cbf_positioner_struct-__init__"><strong>__init__</strong></a>(self, *args)</dt><dd><tt><a href="#cbf_positioner_struct-__init__">__init__</a>(self)&nbsp;-&gt;&nbsp;<a href="#cbf_positioner_struct">cbf_positioner_struct</a></tt></dd></dl>

<dl><dt><a name="cbf_positioner_struct-__repr__"><strong>__repr__</strong></a> = _swig_repr(self)</dt></dl>

<dl><dt><strong>__setattr__</strong> <em>lambda</em> self, name, value</dt></dl>

<dl><dt><a name="cbf_positioner_struct-get_reciprocal"><strong>get_reciprocal</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;double&nbsp;reciprocal1,double&nbsp;reciprocal2,double&nbsp;reciprocal3<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;double&nbsp;ratio,double&nbsp;wavelength,double&nbsp;real1,double&nbsp;real2,double&nbsp;real3<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_reciprocal&nbsp;(cbf_goniometer&nbsp;goniometer,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;&nbsp;&nbsp;&nbsp;reserved,&nbsp;double&nbsp;ratio,&nbsp;double&nbsp;wavelength,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;real1,&nbsp;double&nbsp;real2,&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;real3,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;*reciprocal1,&nbsp;double&nbsp;*reciprocal2,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;&nbsp;&nbsp;&nbsp;*reciprocal3);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_reciprocal&nbsp;sets&nbsp;*reciprocal1,&nbsp;*&nbsp;reciprocal2,&nbsp;and&nbsp;*&nbsp;<br>
reciprocal3&nbsp;to&nbsp;the&nbsp;3&nbsp;components&nbsp;of&nbsp;the&nbsp;of&nbsp;the&nbsp;reciprocal-space&nbsp;vector&nbsp;<br>
corresponding&nbsp;to&nbsp;the&nbsp;real-space&nbsp;vector&nbsp;(real1,&nbsp;real2,&nbsp;real3).&nbsp;The&nbsp;<br>
reciprocal-space&nbsp;vector&nbsp;is&nbsp;oriented&nbsp;to&nbsp;correspond&nbsp;to&nbsp;the&nbsp;goniometer&nbsp;<br>
setting&nbsp;with&nbsp;all&nbsp;axes&nbsp;at&nbsp;0.&nbsp;The&nbsp;value&nbsp;wavelength&nbsp;is&nbsp;the&nbsp;wavlength&nbsp;in&nbsp;<br>
Angstrom&nbsp;and&nbsp;the&nbsp;value&nbsp;ratio&nbsp;specifies&nbsp;the&nbsp;current&nbsp;goniometer&nbsp;setting&nbsp;<br>
and&nbsp;varies&nbsp;from&nbsp;0.0&nbsp;at&nbsp;the&nbsp;beginning&nbsp;of&nbsp;the&nbsp;exposur&nbsp;e&nbsp;to&nbsp;1.0&nbsp;at&nbsp;the&nbsp;<br>
end,&nbsp;irrespective&nbsp;of&nbsp;the&nbsp;actual&nbsp;rotation&nbsp;range.<br>
Any&nbsp;of&nbsp;the&nbsp;destination&nbsp;pointers&nbsp;may&nbsp;be&nbsp;NULL.<br>
The&nbsp;parameter&nbsp;reserved&nbsp;is&nbsp;presently&nbsp;unused&nbsp;and&nbsp;should&nbsp;be&nbsp;set&nbsp;to&nbsp;0.<br>
ARGUMENTS<br>
goniometer&nbsp;&nbsp;&nbsp;Goniometer&nbsp;handle.&nbsp;reserved&nbsp;&nbsp;&nbsp;Unused.&nbsp;Any&nbsp;value&nbsp;other&nbsp;<br>
than&nbsp;0&nbsp;is&nbsp;invalid.&nbsp;ratio&nbsp;&nbsp;&nbsp;Goniometer&nbsp;setting.&nbsp;0&nbsp;=&nbsp;beginning&nbsp;of&nbsp;<br>
exposure,&nbsp;1&nbsp;=&nbsp;end.&nbsp;wavelength&nbsp;&nbsp;&nbsp;Wavelength&nbsp;in&nbsp;Angstrom.&nbsp;real1&nbsp;&nbsp;&nbsp;x&nbsp;<br>
component&nbsp;of&nbsp;the&nbsp;real-space&nbsp;vector.&nbsp;real2&nbsp;&nbsp;&nbsp;y&nbsp;component&nbsp;of&nbsp;the&nbsp;<br>
real-space&nbsp;vector.&nbsp;real3&nbsp;&nbsp;&nbsp;z&nbsp;component&nbsp;of&nbsp;the&nbsp;real-space&nbsp;vector.&nbsp;<br>
reciprocal1&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;x&nbsp;component&nbsp;of&nbsp;the&nbsp;<br>
reciprocal-space&nbsp;vector.&nbsp;reciprocal2&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;y&nbsp;<br>
component&nbsp;of&nbsp;the&nbsp;reciprocal-space&nbsp;vector.&nbsp;reciprocal3&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;<br>
the&nbsp;destination&nbsp;z&nbsp;component&nbsp;of&nbsp;the&nbsp;reciprocal-space&nbsp;vector.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_positioner_struct-get_rotation_axis"><strong>get_rotation_axis</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;double&nbsp;vector1,double&nbsp;vector2,double&nbsp;vector3<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_rotation_axis&nbsp;(cbf_goniometer&nbsp;goniometer,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;&nbsp;&nbsp;&nbsp;reserved,&nbsp;double&nbsp;*vector1,&nbsp;double&nbsp;*vector2,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;vector3);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_rotation_axis&nbsp;sets&nbsp;*vector1,&nbsp;*vector2,&nbsp;and&nbsp;*vector3&nbsp;to&nbsp;the&nbsp;3&nbsp;<br>
components&nbsp;of&nbsp;the&nbsp;goniometer&nbsp;rotation&nbsp;axis&nbsp;used&nbsp;for&nbsp;the&nbsp;exposure.<br>
Any&nbsp;of&nbsp;the&nbsp;destination&nbsp;pointers&nbsp;may&nbsp;be&nbsp;NULL.<br>
The&nbsp;parameter&nbsp;reserved&nbsp;is&nbsp;presently&nbsp;unused&nbsp;and&nbsp;should&nbsp;be&nbsp;set&nbsp;to&nbsp;0.<br>
ARGUMENTS<br>
goniometer&nbsp;&nbsp;&nbsp;Goniometer&nbsp;handle.&nbsp;reserved&nbsp;&nbsp;&nbsp;Unused.&nbsp;Any&nbsp;value&nbsp;other&nbsp;<br>
than&nbsp;0&nbsp;is&nbsp;invalid.&nbsp;vector1&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;x&nbsp;component&nbsp;<br>
of&nbsp;the&nbsp;rotation&nbsp;axis.&nbsp;vector2&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;y&nbsp;<br>
component&nbsp;of&nbsp;the&nbsp;rotation&nbsp;axis.&nbsp;vector3&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;<br>
z&nbsp;component&nbsp;of&nbsp;the&nbsp;rotation&nbsp;axis.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_positioner_struct-get_rotation_range"><strong>get_rotation_range</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;Float&nbsp;start,Float&nbsp;increment<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_rotation_range&nbsp;(cbf_goniometer&nbsp;goniometer,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;&nbsp;&nbsp;&nbsp;reserved,&nbsp;double&nbsp;*start,&nbsp;double&nbsp;*increment);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_rotation_range&nbsp;sets&nbsp;*start&nbsp;and&nbsp;*increment&nbsp;to&nbsp;the&nbsp;<br>
corresponding&nbsp;values&nbsp;of&nbsp;the&nbsp;goniometer&nbsp;rotation&nbsp;axis&nbsp;used&nbsp;for&nbsp;the&nbsp;<br>
exposure.<br>
Either&nbsp;of&nbsp;the&nbsp;destination&nbsp;pointers&nbsp;may&nbsp;be&nbsp;NULL.<br>
The&nbsp;parameter&nbsp;reserved&nbsp;is&nbsp;presently&nbsp;unused&nbsp;and&nbsp;should&nbsp;be&nbsp;set&nbsp;to&nbsp;0.<br>
ARGUMENTS<br>
goniometer&nbsp;&nbsp;&nbsp;Goniometer&nbsp;handle.&nbsp;reserved&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Unused.&nbsp;Any&nbsp;value&nbsp;other&nbsp;<br>
than&nbsp;0&nbsp;is&nbsp;invalid.&nbsp;start&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;start&nbsp;<br>
value.&nbsp;increment&nbsp;&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;increment&nbsp;value.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<dl><dt><a name="cbf_positioner_struct-rotate_vector"><strong>rotate_vector</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;double&nbsp;final1,double&nbsp;final2,double&nbsp;final3<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;double&nbsp;ratio,double&nbsp;initial1,double&nbsp;initial2,double&nbsp;initial3<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_rotate_vector&nbsp;(cbf_goniometer&nbsp;goniometer,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;int&nbsp;&nbsp;&nbsp;&nbsp;reserved,&nbsp;double&nbsp;ratio,&nbsp;double&nbsp;initial1,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;initial2,&nbsp;double&nbsp;&nbsp;&nbsp;&nbsp;initial3,&nbsp;double&nbsp;*final1,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;double&nbsp;*final2,&nbsp;double&nbsp;*final3);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_rotate_vector&nbsp;sets&nbsp;*final1,&nbsp;*final2,&nbsp;and&nbsp;*final3&nbsp;to&nbsp;the&nbsp;3&nbsp;<br>
components&nbsp;of&nbsp;the&nbsp;of&nbsp;the&nbsp;vector&nbsp;(initial1,&nbsp;initial2,&nbsp;initial3)&nbsp;after&nbsp;<br>
reorientation&nbsp;by&nbsp;applying&nbsp;the&nbsp;goniometer&nbsp;rotations.&nbsp;The&nbsp;value&nbsp;ratio&nbsp;<br>
specif&nbsp;ies&nbsp;the&nbsp;goniometer&nbsp;setting&nbsp;and&nbsp;varies&nbsp;from&nbsp;0.0&nbsp;at&nbsp;the&nbsp;<br>
beginning&nbsp;of&nbsp;the&nbsp;exposure&nbsp;to&nbsp;1.0&nbsp;at&nbsp;the&nbsp;end,&nbsp;irrespective&nbsp;of&nbsp;the&nbsp;<br>
actual&nbsp;rotation&nbsp;range.<br>
Any&nbsp;of&nbsp;the&nbsp;destination&nbsp;pointers&nbsp;may&nbsp;be&nbsp;NULL.<br>
The&nbsp;parameter&nbsp;reserved&nbsp;is&nbsp;presently&nbsp;unused&nbsp;and&nbsp;should&nbsp;be&nbsp;set&nbsp;to&nbsp;0.<br>
ARGUMENTS<br>
goniometer&nbsp;&nbsp;&nbsp;Goniometer&nbsp;handle.&nbsp;reserved&nbsp;&nbsp;&nbsp;Unused.&nbsp;Any&nbsp;value&nbsp;other&nbsp;<br>
than&nbsp;0&nbsp;is&nbsp;invalid.&nbsp;ratio&nbsp;&nbsp;&nbsp;Goniometer&nbsp;setting.&nbsp;0&nbsp;=&nbsp;beginning&nbsp;of&nbsp;<br>
exposure,&nbsp;1&nbsp;=&nbsp;end.&nbsp;initial1&nbsp;&nbsp;&nbsp;x&nbsp;component&nbsp;of&nbsp;the&nbsp;initial&nbsp;vector.&nbsp;<br>
initial2&nbsp;&nbsp;&nbsp;y&nbsp;component&nbsp;of&nbsp;the&nbsp;initial&nbsp;vector.&nbsp;initial3&nbsp;&nbsp;&nbsp;z&nbsp;component&nbsp;<br>
of&nbsp;the&nbsp;initial&nbsp;vector.&nbsp;vector1&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;x&nbsp;<br>
component&nbsp;of&nbsp;the&nbsp;final&nbsp;vector.&nbsp;vector2&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;y&nbsp;<br>
component&nbsp;of&nbsp;the&nbsp;final&nbsp;vector.&nbsp;vector3&nbsp;&nbsp;&nbsp;Pointer&nbsp;to&nbsp;the&nbsp;destination&nbsp;z&nbsp;<br>
component&nbsp;of&nbsp;the&nbsp;final&nbsp;vector.<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>

<hr>
Properties defined here:<br>
<dl><dt><strong>axes</strong></dt>
<dd><dl><dt><a name="-<em>get</em>"><strong><em>get</em></strong></a> = cbf_positioner_struct_axes_get(...)</dt></dl>
</dd>
<dd><dl><dt><a name="-<em>set</em>"><strong><em>set</em></strong></a> = cbf_positioner_struct_axes_set(...)</dt></dl>
</dd>
</dl>
<dl><dt><strong>axes_are_connected</strong></dt>
<dd><dl><dt><a name="-<em>get</em>"><strong><em>get</em></strong></a> = cbf_positioner_struct_axes_are_connected_get(...)</dt></dl>
</dd>
<dd><dl><dt><a name="-<em>set</em>"><strong><em>set</em></strong></a> = cbf_positioner_struct_axes_are_connected_set(...)</dt></dl>
</dd>
</dl>
<dl><dt><strong>axis</strong></dt>
<dd><dl><dt><a name="-<em>get</em>"><strong><em>get</em></strong></a> = cbf_positioner_struct_axis_get(...)</dt></dl>
</dd>
<dd><dl><dt><a name="-<em>set</em>"><strong><em>set</em></strong></a> = cbf_positioner_struct_axis_set(...)</dt></dl>
</dd>
</dl>
<dl><dt><strong>matrix</strong></dt>
<dd><dl><dt><a name="-<em>get</em>"><strong><em>get</em></strong></a> = cbf_positioner_struct_matrix_get(...)</dt></dl>
</dd>
<dd><dl><dt><a name="-<em>set</em>"><strong><em>set</em></strong></a> = cbf_positioner_struct_matrix_set(...)</dt></dl>
</dd>
</dl>
<dl><dt><strong>matrix_is_valid</strong></dt>
<dd><dl><dt><a name="-<em>get</em>"><strong><em>get</em></strong></a> = cbf_positioner_struct_matrix_is_valid_get(...)</dt></dl>
</dd>
<dd><dl><dt><a name="-<em>set</em>"><strong><em>set</em></strong></a> = cbf_positioner_struct_matrix_is_valid_set(...)</dt></dl>
</dd>
</dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>__dict__</strong> = &lt;dictproxy object&gt;<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dl>

<dl><dt><strong>__swig_destroy__</strong> = &lt;built-in function delete_cbf_positioner_struct&gt;</dl>

<dl><dt><strong>__swig_getmethods__</strong> = {'axes': &lt;built-in function cbf_positioner_struct_axes_get&gt;, 'axes_are_connected': &lt;built-in function cbf_positioner_struct_axes_are_connected_get&gt;, 'axis': &lt;built-in function cbf_positioner_struct_axis_get&gt;, 'matrix': &lt;built-in function cbf_positioner_struct_matrix_get&gt;, 'matrix_is_valid': &lt;built-in function cbf_positioner_struct_matrix_is_valid_get&gt;}</dl>

<dl><dt><strong>__swig_setmethods__</strong> = {'axes': &lt;built-in function cbf_positioner_struct_axes_set&gt;, 'axes_are_connected': &lt;built-in function cbf_positioner_struct_axes_are_connected_set&gt;, 'axis': &lt;built-in function cbf_positioner_struct_axis_set&gt;, 'matrix': &lt;built-in function cbf_positioner_struct_matrix_set&gt;, 'matrix_is_valid': &lt;built-in function cbf_positioner_struct_matrix_is_valid_set&gt;}</dl>

<dl><dt><strong>__weakref__</strong> = &lt;attribute '__weakref__' of 'cbf_positioner_struct' objects&gt;<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;(if&nbsp;defined)</tt></dl>

</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
    
<tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl><dt><a name="-cbf_detector_struct_swigregister"><strong>cbf_detector_struct_swigregister</strong></a>(...)</dt></dl>
 <dl><dt><a name="-cbf_handle_struct_swigregister"><strong>cbf_handle_struct_swigregister</strong></a>(...)</dt></dl>
 <dl><dt><a name="-cbf_positioner_struct_swigregister"><strong>cbf_positioner_struct_swigregister</strong></a>(...)</dt></dl>
 <dl><dt><a name="-get_local_integer_byte_order"><strong>get_local_integer_byte_order</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;string<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_local_integer_byte_order&nbsp;(char&nbsp;**&nbsp;byte_order);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_local_integer_byte_order&nbsp;returns&nbsp;the&nbsp;byte&nbsp;order&nbsp;of&nbsp;integers&nbsp;<br>
on&nbsp;the&nbsp;machine&nbsp;on&nbsp;which&nbsp;the&nbsp;API&nbsp;is&nbsp;being&nbsp;run&nbsp;in&nbsp;the&nbsp;form&nbsp;of&nbsp;a&nbsp;<br>
character&nbsp;string&nbsp;returned&nbsp;as&nbsp;the&nbsp;value&nbsp;pointed&nbsp;to&nbsp;by&nbsp;byte_order.&nbsp;<br>
cbf_get_local_real_byte_order&nbsp;returns&nbsp;the&nbsp;byte&nbsp;order&nbsp;of&nbsp;reals&nbsp;on&nbsp;the&nbsp;<br>
machine&nbsp;on&nbsp;which&nbsp;the&nbsp;API&nbsp;is&nbsp;being&nbsp;run&nbsp;in&nbsp;the&nbsp;form&nbsp;of&nbsp;a&nbsp;character&nbsp;<br>
string&nbsp;returned&nbsp;as&nbsp;the&nbsp;value&nbsp;pointed&nbsp;to&nbsp;by&nbsp;byte_order.&nbsp;<br>
cbf_get_local_real_format&nbsp;returns&nbsp;the&nbsp;format&nbsp;of&nbsp;floats&nbsp;on&nbsp;the&nbsp;machine&nbsp;<br>
on&nbsp;which&nbsp;the&nbsp;API&nbsp;is&nbsp;being&nbsp;run&nbsp;in&nbsp;the&nbsp;form&nbsp;of&nbsp;a&nbsp;character&nbsp;string&nbsp;<br>
returned&nbsp;as&nbsp;the&nbsp;value&nbsp;pointed&nbsp;to&nbsp;by&nbsp;real_format.&nbsp;The&nbsp;strings&nbsp;returned&nbsp;<br>
must&nbsp;not&nbsp;be&nbsp;modified&nbsp;in&nbsp;any&nbsp;way.<br>
The&nbsp;values&nbsp;returned&nbsp;in&nbsp;byte_order&nbsp;may&nbsp;be&nbsp;the&nbsp;strings&nbsp;<br>
"little_endian"&nbsp;or&nbsp;"big-endian".&nbsp;The&nbsp;values&nbsp;returned&nbsp;in&nbsp;<br>
real_format&nbsp;may&nbsp;be&nbsp;the&nbsp;strings&nbsp;"ieee&nbsp;754-1985"&nbsp;or&nbsp;"other".&nbsp;<br>
Additional&nbsp;values&nbsp;may&nbsp;be&nbsp;returned&nbsp;by&nbsp;future&nbsp;versions&nbsp;of&nbsp;the&nbsp;API.<br>
ARGUMENTS<br>
byte_order&nbsp;&nbsp;&nbsp;&nbsp;pointer&nbsp;to&nbsp;the&nbsp;returned&nbsp;string&nbsp;real_format&nbsp;&nbsp;&nbsp;pointer&nbsp;to&nbsp;<br>
the&nbsp;returned&nbsp;string<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>
 <dl><dt><a name="-get_local_real_byte_order"><strong>get_local_real_byte_order</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;string<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_local_real_byte_order&nbsp;(char&nbsp;**&nbsp;byte_order);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_local_integer_byte_order&nbsp;returns&nbsp;the&nbsp;byte&nbsp;order&nbsp;of&nbsp;integers&nbsp;<br>
on&nbsp;the&nbsp;machine&nbsp;on&nbsp;which&nbsp;the&nbsp;API&nbsp;is&nbsp;being&nbsp;run&nbsp;in&nbsp;the&nbsp;form&nbsp;of&nbsp;a&nbsp;<br>
character&nbsp;string&nbsp;returned&nbsp;as&nbsp;the&nbsp;value&nbsp;pointed&nbsp;to&nbsp;by&nbsp;byte_order.&nbsp;<br>
cbf_get_local_real_byte_order&nbsp;returns&nbsp;the&nbsp;byte&nbsp;order&nbsp;of&nbsp;reals&nbsp;on&nbsp;the&nbsp;<br>
machine&nbsp;on&nbsp;which&nbsp;the&nbsp;API&nbsp;is&nbsp;being&nbsp;run&nbsp;in&nbsp;the&nbsp;form&nbsp;of&nbsp;a&nbsp;character&nbsp;<br>
string&nbsp;returned&nbsp;as&nbsp;the&nbsp;value&nbsp;pointed&nbsp;to&nbsp;by&nbsp;byte_order.&nbsp;<br>
cbf_get_local_real_format&nbsp;returns&nbsp;the&nbsp;format&nbsp;of&nbsp;floats&nbsp;on&nbsp;the&nbsp;machine&nbsp;<br>
on&nbsp;which&nbsp;the&nbsp;API&nbsp;is&nbsp;being&nbsp;run&nbsp;in&nbsp;the&nbsp;form&nbsp;of&nbsp;a&nbsp;character&nbsp;string&nbsp;<br>
returned&nbsp;as&nbsp;the&nbsp;value&nbsp;pointed&nbsp;to&nbsp;by&nbsp;real_format.&nbsp;The&nbsp;strings&nbsp;returned&nbsp;<br>
must&nbsp;not&nbsp;be&nbsp;modified&nbsp;in&nbsp;any&nbsp;way.<br>
The&nbsp;values&nbsp;returned&nbsp;in&nbsp;byte_order&nbsp;may&nbsp;be&nbsp;the&nbsp;strings&nbsp;<br>
"little_endian"&nbsp;or&nbsp;"big-endian".&nbsp;The&nbsp;values&nbsp;returned&nbsp;in&nbsp;<br>
real_format&nbsp;may&nbsp;be&nbsp;the&nbsp;strings&nbsp;"ieee&nbsp;754-1985"&nbsp;or&nbsp;"other".&nbsp;<br>
Additional&nbsp;values&nbsp;may&nbsp;be&nbsp;returned&nbsp;by&nbsp;future&nbsp;versions&nbsp;of&nbsp;the&nbsp;API.<br>
ARGUMENTS<br>
byte_order&nbsp;&nbsp;&nbsp;&nbsp;pointer&nbsp;to&nbsp;the&nbsp;returned&nbsp;string&nbsp;real_format&nbsp;&nbsp;&nbsp;pointer&nbsp;to&nbsp;<br>
the&nbsp;returned&nbsp;string<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>
 <dl><dt><a name="-get_local_real_format"><strong>get_local_real_format</strong></a>(*args)</dt><dd><tt>Returns&nbsp;:&nbsp;string<br>
*args&nbsp;&nbsp;&nbsp;:&nbsp;<br>
&nbsp;<br>
C&nbsp;prototype:&nbsp;int&nbsp;cbf_get_local_real_format&nbsp;(char&nbsp;**&nbsp;real_format&nbsp;);<br>
&nbsp;<br>
CBFLib&nbsp;documentation:<br>
DESCRIPTION<br>
cbf_get_local_integer_byte_order&nbsp;returns&nbsp;the&nbsp;byte&nbsp;order&nbsp;of&nbsp;integers&nbsp;<br>
on&nbsp;the&nbsp;machine&nbsp;on&nbsp;which&nbsp;the&nbsp;API&nbsp;is&nbsp;being&nbsp;run&nbsp;in&nbsp;the&nbsp;form&nbsp;of&nbsp;a&nbsp;<br>
character&nbsp;string&nbsp;returned&nbsp;as&nbsp;the&nbsp;value&nbsp;pointed&nbsp;to&nbsp;by&nbsp;byte_order.&nbsp;<br>
cbf_get_local_real_byte_order&nbsp;returns&nbsp;the&nbsp;byte&nbsp;order&nbsp;of&nbsp;reals&nbsp;on&nbsp;the&nbsp;<br>
machine&nbsp;on&nbsp;which&nbsp;the&nbsp;API&nbsp;is&nbsp;being&nbsp;run&nbsp;in&nbsp;the&nbsp;form&nbsp;of&nbsp;a&nbsp;character&nbsp;<br>
string&nbsp;returned&nbsp;as&nbsp;the&nbsp;value&nbsp;pointed&nbsp;to&nbsp;by&nbsp;byte_order.&nbsp;<br>
cbf_get_local_real_format&nbsp;returns&nbsp;the&nbsp;format&nbsp;of&nbsp;floats&nbsp;on&nbsp;the&nbsp;machine&nbsp;<br>
on&nbsp;which&nbsp;the&nbsp;API&nbsp;is&nbsp;being&nbsp;run&nbsp;in&nbsp;the&nbsp;form&nbsp;of&nbsp;a&nbsp;character&nbsp;string&nbsp;<br>
returned&nbsp;as&nbsp;the&nbsp;value&nbsp;pointed&nbsp;to&nbsp;by&nbsp;real_format.&nbsp;The&nbsp;strings&nbsp;returned&nbsp;<br>
must&nbsp;not&nbsp;be&nbsp;modified&nbsp;in&nbsp;any&nbsp;way.<br>
The&nbsp;values&nbsp;returned&nbsp;in&nbsp;byte_order&nbsp;may&nbsp;be&nbsp;the&nbsp;strings&nbsp;<br>
"little_endian"&nbsp;or&nbsp;"big-endian".&nbsp;The&nbsp;values&nbsp;returned&nbsp;in&nbsp;<br>
real_format&nbsp;may&nbsp;be&nbsp;the&nbsp;strings&nbsp;"ieee&nbsp;754-1985"&nbsp;or&nbsp;"other".&nbsp;<br>
Additional&nbsp;values&nbsp;may&nbsp;be&nbsp;returned&nbsp;by&nbsp;future&nbsp;versions&nbsp;of&nbsp;the&nbsp;API.<br>
ARGUMENTS<br>
byte_order&nbsp;&nbsp;&nbsp;&nbsp;pointer&nbsp;to&nbsp;the&nbsp;returned&nbsp;string&nbsp;real_format&nbsp;&nbsp;&nbsp;pointer&nbsp;to&nbsp;<br>
the&nbsp;returned&nbsp;string<br>
RETURN&nbsp;VALUE<br>
Returns&nbsp;an&nbsp;error&nbsp;code&nbsp;on&nbsp;failure&nbsp;or&nbsp;0&nbsp;for&nbsp;success.&nbsp;<br>
_________________________________________________________________</tt></dd></dl>
</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
    
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><strong>CBF</strong> = 0<br>
<strong>CBF_BYTE_OFFSET</strong> = 112<br>
<strong>CBF_CANONICAL</strong> = 80<br>
<strong>CBF_CATEGORY</strong> = 5<br>
<strong>CBF_COLUMN</strong> = 6<br>
<strong>CBF_DATABLOCK</strong> = 3<br>
<strong>CBF_FLOAT</strong> = 32<br>
<strong>CBF_INTEGER</strong> = 16<br>
<strong>CBF_LINK</strong> = 1<br>
<strong>CBF_NONE</strong> = 64<br>
<strong>CBF_PACKED</strong> = 96<br>
<strong>CBF_PREDICTOR</strong> = 128<br>
<strong>CBF_ROOT</strong> = 2<br>
<strong>CBF_SAVEFRAME</strong> = 4<br>
<strong>CBF_UNDEFINED</strong> = 65536<br>
<strong>CBF_UNDEFNODE</strong> = 0<br>
<strong>CIF</strong> = 1<br>
<strong>ENC_BACKWARD</strong> = 128<br>
<strong>ENC_BASE10</strong> = 8<br>
<strong>ENC_BASE16</strong> = 16<br>
<strong>ENC_BASE64</strong> = 2<br>
<strong>ENC_BASE8</strong> = 32<br>
<strong>ENC_CRTERM</strong> = 256<br>
<strong>ENC_DEFAULT</strong> = 578<br>
<strong>ENC_FORWARD</strong> = 64<br>
<strong>ENC_LFTERM</strong> = 512<br>
<strong>ENC_NONE</strong> = 1<br>
<strong>ENC_QP</strong> = 4<br>
<strong>HDR_DEFAULT</strong> = 6<br>
<strong>MIME_HEADERS</strong> = 2<br>
<strong>MIME_NOHEADERS</strong> = 1<br>
<strong>MSG_DIGEST</strong> = 8<br>
<strong>MSG_DIGESTNOW</strong> = 16<br>
<strong>MSG_NODIGEST</strong> = 4<br>
<strong>PLAIN_HEADERS</strong> = 1<br>
<strong>__author__</strong> = 'Jon Wright &lt;wright@esrf.fr&gt;'<br>
<strong>__credits__</strong> = 'Paul Ellis and Herbert Bernstein for the excellent CBFlib!'<br>
<strong>__date__</strong> = '14 Dec 2005'<br>
<strong>__version__</strong> = 'still_being_written'</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#7799ee">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
    
<tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%">Jon&nbsp;Wright&nbsp;&lt;wright@esrf.fr&gt;</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#7799ee">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Credits</strong></big></font></td></tr>
    
<tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%">Paul&nbsp;Ellis&nbsp;and&nbsp;Herbert&nbsp;Bernstein&nbsp;for&nbsp;the&nbsp;excellent&nbsp;CBFlib!</td></tr></table>
</body></html>