<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>SDTS_AL: DDFSubfieldDefn Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>DDFSubfieldDefn Class Reference</h1><!-- doxytag: class="DDFSubfieldDefn" -->
<p><code>#include <<a class="el" href="iso8211_8h_source.html">iso8211.h</a>></code></p>
<p><a href="classDDFSubfieldDefn-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFSubfieldDefn.html#af2be10e48df9291c302eddc20d630a0c">DDFBinaryFormat</a> </td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFSubfieldDefn.html#a2fdfa7e689051d44242eb2a46407a756">GetName</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFSubfieldDefn.html#a4d0a4b03f2f3f6ea71d26b2e2dcdcd3f">GetFormat</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">DDFDataType </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFSubfieldDefn.html#ad5bf003ff800ff8acaee62718ae72472">GetType</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFSubfieldDefn.html#a67fddf36a98106bf445ea49811812b00">ExtractFloatData</a> (const char *pachData, int nMaxBytes, int *pnConsumedBytes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFSubfieldDefn.html#a32ecb1b1e3da05e500049e4925dd20e5">ExtractIntData</a> (const char *pachData, int nMaxBytes, int *pnConsumedBytes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFSubfieldDefn.html#ad95ecafda6bcf87437030c273eb06643">ExtractStringData</a> (const char *pachData, int nMaxBytes, int *pnConsumedBytes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFSubfieldDefn.html#abe4b3c8e16a3131e457094be08d26faf">GetDataLength</a> (const char *, int, int *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFSubfieldDefn.html#a2eef42775cb6979f1758e68e86886db2">DumpData</a> (const char *pachData, int nMaxBytes, FILE *fp)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFSubfieldDefn.html#aba44dc5676bf33cb03fcd0cf2e1ff8af">FormatStringValue</a> (char *pachData, int nBytesAvailable, int *pnBytesUsed, const char *pszValue, int nValueLength=-1)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFSubfieldDefn.html#a57f3ce3f82dd32a03389b63d7fa3e8dd">FormatIntValue</a> (char *pachData, int nBytesAvailable, int *pnBytesUsed, int nNewValue)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFSubfieldDefn.html#ae4e8485aab8a8c54e80408147d4b164a">FormatFloatValue</a> (char *pachData, int nBytesAvailable, int *pnBytesUsed, double dfNewValue)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFSubfieldDefn.html#a64fad8aa359e312db97d69245acd7317">GetWidth</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFSubfieldDefn.html#a0309567dd58d4b878826d5928f9c8b9a">GetDefaultValue</a> (char *pachData, int nBytesAvailable, int *pnBytesUsed)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFSubfieldDefn.html#ace8e51966364c8bba8c800dc46df7af2">Dump</a> (FILE *fp)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Information from the DDR record describing one subfield of a <a class="el" href="classDDFFieldDefn.html">DDFFieldDefn</a>. All subfields of a field will occur in each occurance of that field (as a <a class="el" href="classDDFField.html">DDFField</a>) in a <a class="el" href="classDDFRecord.html">DDFRecord</a>. Subfield's actually contain formatted data (as instances within a record). </p>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="af2be10e48df9291c302eddc20d630a0c"></a><!-- doxytag: member="DDFSubfieldDefn::DDFBinaryFormat" ref="af2be10e48df9291c302eddc20d630a0c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classDDFSubfieldDefn.html#af2be10e48df9291c302eddc20d630a0c">DDFSubfieldDefn::DDFBinaryFormat</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Binary format: this is the digit immediately following the B or b for binary formats. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ace8e51966364c8bba8c800dc46df7af2"></a><!-- doxytag: member="DDFSubfieldDefn::Dump" ref="ace8e51966364c8bba8c800dc46df7af2" args="(FILE *fp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DDFSubfieldDefn::Dump </td>
<td>(</td>
<td class="paramtype">FILE * </td>
<td class="paramname"> <em>fp</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Write out subfield definition info to debugging file.</p>
<p>A variety of information about this field definition is written to the give debugging file handle.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>fp</em> </td><td>The standard io file handle to write to. ie. stderr </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2eef42775cb6979f1758e68e86886db2"></a><!-- doxytag: member="DDFSubfieldDefn::DumpData" ref="a2eef42775cb6979f1758e68e86886db2" args="(const char *pachData, int nMaxBytes, FILE *fp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DDFSubfieldDefn::DumpData </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pachData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nMaxBytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FILE * </td>
<td class="paramname"> <em>fp</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Dump subfield value to debugging file.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pachData</em> </td><td>Pointer to data for this subfield. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nMaxBytes</em> </td><td>Maximum number of bytes available in pachData. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fp</em> </td><td>File to write report to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a67fddf36a98106bf445ea49811812b00"></a><!-- doxytag: member="DDFSubfieldDefn::ExtractFloatData" ref="a67fddf36a98106bf445ea49811812b00" args="(const char *pachData, int nMaxBytes, int *pnConsumedBytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double DDFSubfieldDefn::ExtractFloatData </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pachSourceData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nMaxBytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>pnConsumedBytes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Extract a subfield value as a float. Given a pointer to the data for this subfield (from within a <a class="el" href="classDDFRecord.html">DDFRecord</a>) this method will return the floating point data for this subfield. The number of bytes consumed as part of this field can also be fetched. This method may be called for any type of subfield, and will return zero if the subfield is not numeric.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pachSourceData</em> </td><td>The pointer to the raw data for this field. This may have come from <a class="el" href="classDDFRecord.html#acc2ca3e7a74a361daa11b53e15770871">DDFRecord::GetData()</a>, taking into account skip factors over previous subfields data. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nMaxBytes</em> </td><td>The maximum number of bytes that are accessable after pachSourceData. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pnConsumedBytes</em> </td><td>Pointer to an integer into which the number of bytes consumed by this field should be written. May be NULL to ignore. This is used as a skip factor to increment pachSourceData to point to the next subfields data.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The subfield's numeric value (or zero if it isn't numeric).</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classDDFSubfieldDefn.html#a32ecb1b1e3da05e500049e4925dd20e5">ExtractIntData()</a>, <a class="el" href="classDDFSubfieldDefn.html#ad95ecafda6bcf87437030c273eb06643">ExtractStringData()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a32ecb1b1e3da05e500049e4925dd20e5"></a><!-- doxytag: member="DDFSubfieldDefn::ExtractIntData" ref="a32ecb1b1e3da05e500049e4925dd20e5" args="(const char *pachData, int nMaxBytes, int *pnConsumedBytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int DDFSubfieldDefn::ExtractIntData </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pachSourceData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nMaxBytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>pnConsumedBytes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Extract a subfield value as an integer. Given a pointer to the data for this subfield (from within a <a class="el" href="classDDFRecord.html">DDFRecord</a>) this method will return the int data for this subfield. The number of bytes consumed as part of this field can also be fetched. This method may be called for any type of subfield, and will return zero if the subfield is not numeric.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pachSourceData</em> </td><td>The pointer to the raw data for this field. This may have come from <a class="el" href="classDDFRecord.html#acc2ca3e7a74a361daa11b53e15770871">DDFRecord::GetData()</a>, taking into account skip factors over previous subfields data. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nMaxBytes</em> </td><td>The maximum number of bytes that are accessable after pachSourceData. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pnConsumedBytes</em> </td><td>Pointer to an integer into which the number of bytes consumed by this field should be written. May be NULL to ignore. This is used as a skip factor to increment pachSourceData to point to the next subfields data.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The subfield's numeric value (or zero if it isn't numeric).</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classDDFSubfieldDefn.html#a67fddf36a98106bf445ea49811812b00">ExtractFloatData()</a>, <a class="el" href="classDDFSubfieldDefn.html#ad95ecafda6bcf87437030c273eb06643">ExtractStringData()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ad95ecafda6bcf87437030c273eb06643"></a><!-- doxytag: member="DDFSubfieldDefn::ExtractStringData" ref="ad95ecafda6bcf87437030c273eb06643" args="(const char *pachData, int nMaxBytes, int *pnConsumedBytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * DDFSubfieldDefn::ExtractStringData </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pachSourceData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nMaxBytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>pnConsumedBytes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Extract a zero terminated string containing the data for this subfield. Given a pointer to the data for this subfield (from within a <a class="el" href="classDDFRecord.html">DDFRecord</a>) this method will return the data for this subfield. The number of bytes consumed as part of this field can also be fetched. This number may be one longer than the string length if there is a terminator character used.</p>
<p>This function will return the raw binary data of a subfield for types other than DDFString, including data past zero chars. This is the standard way of extracting DDFBinaryString subfields for instance.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pachSourceData</em> </td><td>The pointer to the raw data for this field. This may have come from <a class="el" href="classDDFRecord.html#acc2ca3e7a74a361daa11b53e15770871">DDFRecord::GetData()</a>, taking into account skip factors over previous subfields data. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nMaxBytes</em> </td><td>The maximum number of bytes that are accessable after pachSourceData. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pnConsumedBytes</em> </td><td>Pointer to an integer into which the number of bytes consumed by this field should be written. May be NULL to ignore. This is used as a skip factor to increment pachSourceData to point to the next subfields data.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to a buffer containing the data for this field. The returned pointer is to an internal buffer which is invalidated on the next <a class="el" href="classDDFSubfieldDefn.html#ad95ecafda6bcf87437030c273eb06643">ExtractStringData()</a> call on this DDFSubfieldDefn(). It should not be freed by the application.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classDDFSubfieldDefn.html#a32ecb1b1e3da05e500049e4925dd20e5">ExtractIntData()</a>, <a class="el" href="classDDFSubfieldDefn.html#a67fddf36a98106bf445ea49811812b00">ExtractFloatData()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ae4e8485aab8a8c54e80408147d4b164a"></a><!-- doxytag: member="DDFSubfieldDefn::FormatFloatValue" ref="ae4e8485aab8a8c54e80408147d4b164a" args="(char *pachData, int nBytesAvailable, int *pnBytesUsed, double dfNewValue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int DDFSubfieldDefn::FormatFloatValue </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>pachData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nBytesAvailable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>pnBytesUsed</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>dfNewValue</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Format float subfield value.</p>
<p>Returns a buffer with the passed in float value reformatted in a way suitable for storage in a <a class="el" href="classDDFField.html">DDFField</a> for this subfield. </p>
</div>
</div>
<a class="anchor" id="a57f3ce3f82dd32a03389b63d7fa3e8dd"></a><!-- doxytag: member="DDFSubfieldDefn::FormatIntValue" ref="a57f3ce3f82dd32a03389b63d7fa3e8dd" args="(char *pachData, int nBytesAvailable, int *pnBytesUsed, int nNewValue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int DDFSubfieldDefn::FormatIntValue </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>pachData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nBytesAvailable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>pnBytesUsed</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nNewValue</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Format int subfield value.</p>
<p>Returns a buffer with the passed in int value reformatted in a way suitable for storage in a <a class="el" href="classDDFField.html">DDFField</a> for this subfield. </p>
</div>
</div>
<a class="anchor" id="aba44dc5676bf33cb03fcd0cf2e1ff8af"></a><!-- doxytag: member="DDFSubfieldDefn::FormatStringValue" ref="aba44dc5676bf33cb03fcd0cf2e1ff8af" args="(char *pachData, int nBytesAvailable, int *pnBytesUsed, const char *pszValue, int nValueLength=-1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int DDFSubfieldDefn::FormatStringValue </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>pachData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nBytesAvailable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>pnBytesUsed</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pszValue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nValueLength</em> = <code>-1</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Format string subfield value.</p>
<p>Returns a buffer with the passed in string value reformatted in a way suitable for storage in a <a class="el" href="classDDFField.html">DDFField</a> for this subfield. </p>
</div>
</div>
<a class="anchor" id="abe4b3c8e16a3131e457094be08d26faf"></a><!-- doxytag: member="DDFSubfieldDefn::GetDataLength" ref="abe4b3c8e16a3131e457094be08d26faf" args="(const char *, int, int *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int DDFSubfieldDefn::GetDataLength </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pachSourceData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nMaxBytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>pnConsumedBytes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Scan for the end of variable length data. Given a pointer to the data for this subfield (from within a <a class="el" href="classDDFRecord.html">DDFRecord</a>) this method will return the number of bytes which are data for this subfield. The number of bytes consumed as part of this field can also be fetched. This number may be one longer than the length if there is a terminator character used.</p>
<p>This method is mainly for internal use, or for applications which want the raw binary data to interpret themselves. Otherwise use one of <a class="el" href="classDDFSubfieldDefn.html#ad95ecafda6bcf87437030c273eb06643">ExtractStringData()</a>, <a class="el" href="classDDFSubfieldDefn.html#a32ecb1b1e3da05e500049e4925dd20e5">ExtractIntData()</a> or <a class="el" href="classDDFSubfieldDefn.html#a67fddf36a98106bf445ea49811812b00">ExtractFloatData()</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pachSourceData</em> </td><td>The pointer to the raw data for this field. This may have come from <a class="el" href="classDDFRecord.html#acc2ca3e7a74a361daa11b53e15770871">DDFRecord::GetData()</a>, taking into account skip factors over previous subfields data. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nMaxBytes</em> </td><td>The maximum number of bytes that are accessable after pachSourceData. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pnConsumedBytes</em> </td><td>Pointer to an integer into which the number of bytes consumed by this field should be written. May be NULL to ignore.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of bytes at pachSourceData which are actual data for this record (not including unit, or field terminator). </dd></dl>
</div>
</div>
<a class="anchor" id="a0309567dd58d4b878826d5928f9c8b9a"></a><!-- doxytag: member="DDFSubfieldDefn::GetDefaultValue" ref="a0309567dd58d4b878826d5928f9c8b9a" args="(char *pachData, int nBytesAvailable, int *pnBytesUsed)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int DDFSubfieldDefn::GetDefaultValue </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>pachData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nBytesAvailable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>pnBytesUsed</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get default data.</p>
<p>Returns the default subfield data contents for this subfield definition. For variable length numbers this will normally be "0<unit-terminator>". For variable length strings it will be "<unit-terminator>". For fixed length numbers it is zero filled. For fixed length strings it is space filled. For binary numbers it is binary zero filled.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pachData</em> </td><td>the buffer into which the returned default will be placed. May be NULL if just querying default size. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nBytesAvailable</em> </td><td>the size of pachData in bytes. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pnBytesUsed</em> </td><td>will receive the size of the subfield default data in bytes.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE on success or FALSE on failure or if the passed buffer is too small to hold the default. </dd></dl>
</div>
</div>
<a class="anchor" id="a4d0a4b03f2f3f6ea71d26b2e2dcdcd3f"></a><!-- doxytag: member="DDFSubfieldDefn::GetFormat" ref="a4d0a4b03f2f3f6ea71d26b2e2dcdcd3f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* DDFSubfieldDefn::GetFormat </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get pointer to subfield format string </p>
</div>
</div>
<a class="anchor" id="a2fdfa7e689051d44242eb2a46407a756"></a><!-- doxytag: member="DDFSubfieldDefn::GetName" ref="a2fdfa7e689051d44242eb2a46407a756" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* DDFSubfieldDefn::GetName </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get pointer to subfield name. </p>
</div>
</div>
<a class="anchor" id="ad5bf003ff800ff8acaee62718ae72472"></a><!-- doxytag: member="DDFSubfieldDefn::GetType" ref="ad5bf003ff800ff8acaee62718ae72472" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DDFDataType DDFSubfieldDefn::GetType </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the general type of the subfield. This can be used to determine which of <a class="el" href="classDDFSubfieldDefn.html#a67fddf36a98106bf445ea49811812b00">ExtractFloatData()</a>, <a class="el" href="classDDFSubfieldDefn.html#a32ecb1b1e3da05e500049e4925dd20e5">ExtractIntData()</a> or <a class="el" href="classDDFSubfieldDefn.html#ad95ecafda6bcf87437030c273eb06643">ExtractStringData()</a> should be used. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The subfield type. One of DDFInt, DDFFloat, DDFString or DDFBinaryString. </dd></dl>
</div>
</div>
<a class="anchor" id="a64fad8aa359e312db97d69245acd7317"></a><!-- doxytag: member="DDFSubfieldDefn::GetWidth" ref="a64fad8aa359e312db97d69245acd7317" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int DDFSubfieldDefn::GetWidth </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the subfield width (zero for variable). </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="iso8211_8h_source.html">iso8211.h</a></li>
<li>ddfsubfielddefn.cpp</li>
</ul>
</div>
<hr>
Generated for GDAL by
<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.6.2-20100208.
</body>
</html>
