If the search is successful (i.e. a card is found which matches the template),
the contents of the card are (optionally) returned and the Card attribute is
adjusted to identify the card found or, if required, the one following it. If the
search is not successful, the function returns zero and the Card attribute
is set to the
"which are capable of matching a range of characters (see the
"section for details). In this case, the first card with a keyword which matches the template will be found. To find the next FITS card regardless of its keyword, you should use the template
’s Card attribute will be set to the index of the card that was found. If it is non-zero, however, the Card attribute will be incremented to identify the card which follows the one found.
", card, 1 );
"template matches any keyword).
", card, 1 );
"keyword and returns that card. The Card attribute is then incremented to identify the card that follows it.
", NULL, 0 );
", card, 1 );
"(for example, any of the keywords
"would be matched). The card found (if any) is returned, and the Card attribute is then incremented to identify the following card (ready to search for another keyword with the same form, perhaps).
The search always starts with the current card, as identified by the Card attribute. To
ensure you search the entire contents of a FitsChan, you should first clear the Card
attribute (using astClear). This effectively
" the FitsChan.
If a search is unsuccessful, the Card attribute is set to the
" (i.e. to
one more than the number of cards in the FitsChan). No error occurs.
A value of zero will be returned if this function is invoked with the AST error status set, or if it should fail for any reason.
"which can match a range of possible characters. This allows you to search for keywords that contain (for example) numbers, where the digits comprising the number are not known in advance.
A field specifier starts with a
" character. This is followed by an optional single
digit (0 to 9) specifying a field width. Finally, there is a single character which
type of character to be matched, as follows:
" : matches all upper case letters,
" : matches all decimal digits,
" : matches all characters which are permitted within a FITS keyword (upper case
letters, digits, underscores and hyphens).
If the field width is omitted, the field specifier matches one or more characters. If the field width is zero, it matches zero or more characters. Otherwise, it matches exactly the number of
characters specified. In addition to this:
" will match a blank FITS keyword consisting of 8 spaces (as well as
matching all other keywords).
A template consisting of 8 spaces will match a blank keyword (only).
" will match the keyword
" will match keywords consisting of
" followed by one
" will match any keyword starting with
" and followed by one or
" will match any keyword beginning with
" will match any keyword at all (including a blank one).