<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.4"/> <title>WCSLIB 4.18: fitskeyid Struct Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">WCSLIB 4.18 </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.4 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <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>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="functions.html"><span>Data Fields</span></a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-attribs">Data Fields</a> </div> <div class="headertitle"> <div class="title">fitskeyid Struct Reference</div> </div> </div><!--header--> <div class="contents"> <p>Keyword indexing. <a href="structfitskeyid.html#details">More...</a></p> <p><code>#include <<a class="el" href="fitshdr_8h_source.html">fitshdr.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> Data Fields</h2></td></tr> <tr class="memitem:a9c19a56e7a92c1728bebd92e5370b9c7"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structfitskeyid.html#a9c19a56e7a92c1728bebd92e5370b9c7">name</a> [12]</td></tr> <tr class="separator:a9c19a56e7a92c1728bebd92e5370b9c7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab20aa3220d9994d02a1791e35dc91a56"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfitskeyid.html#ab20aa3220d9994d02a1791e35dc91a56">count</a></td></tr> <tr class="separator:ab20aa3220d9994d02a1791e35dc91a56"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8c8c5a6be67ef57333e80e71f320b62e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfitskeyid.html#a8c8c5a6be67ef57333e80e71f320b62e">idx</a> [2]</td></tr> <tr class="separator:a8c8c5a6be67ef57333e80e71f320b62e"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p><a class="el" href="fitshdr_8h.html#aebb4607327b6db35b468517328f67878" title="FITS header parser routine. ">fitshdr()</a> uses the <b>fitskeyid</b> struct to return indexing information for specified keywords. The struct contains three members, the first of which, <a class="el" href="structfitskeyid.html#a9c19a56e7a92c1728bebd92e5370b9c7">fitskeyid::name</a>, must be set by the user with the remainder returned by <a class="el" href="fitshdr_8h.html#aebb4607327b6db35b468517328f67878" title="FITS header parser routine. ">fitshdr()</a>. </p> </div><h2 class="groupheader">Field Documentation</h2> <a class="anchor" id="a9c19a56e7a92c1728bebd92e5370b9c7"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">char fitskeyid::name</td> </tr> </table> </div><div class="memdoc"> <p>(<em>Given</em>) Name of the required keyword. This is to be set by the user; the '.' character may be used for wildcarding. Trailing blanks will be replaced with nulls. </p> </div> </div> <a class="anchor" id="ab20aa3220d9994d02a1791e35dc91a56"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int fitskeyid::count</td> </tr> </table> </div><div class="memdoc"> <p>(<em>Returned</em>) The number of matches found for the keyword. </p> </div> </div> <a class="anchor" id="a8c8c5a6be67ef57333e80e71f320b62e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int fitskeyid::idx</td> </tr> </table> </div><div class="memdoc"> <p>(<em>Returned</em>) Indices into keys[], the array of <a class="el" href="structfitskey.html" title="Keyword/value information. ">fitskey</a> structs returned by <a class="el" href="fitshdr_8h.html#aebb4607327b6db35b468517328f67878" title="FITS header parser routine. ">fitshdr()</a>. Note that these are 0-relative array indices, not keyrecord numbers.</p> <p>If the keyword is found in the header the first index will be set to the array index of its first occurrence, otherwise it will be set to -1.</p> <p>If multiples of the keyword are found, the second index will be set to the array index of its last occurrence, otherwise it will be set to -1. </p> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Sat Jul 13 2013 20:00:27 for WCSLIB 4.18 by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.4 </small></address> </body> </html>