NAME¶

shishi_tkts_find - API function

SYNOPSIS¶

#include <shishi.h>

Shishi_tkt * shishi_tkts_find(Shishi_tkts * tkts, Shishi_tkts_hint * hint);

ARGUMENTS¶

Shishi_tkts * tkts

ticket set handle as allocated by shishi_tkts().

Shishi_tkts_hint * hint

structure with characteristics of ticket to be found.

DESCRIPTION¶

Search the ticketset sequentially (from ticket number 0 through all tickets in the set) for a ticket that fits the given characteristics. If a ticket is found, the hint->startpos field is updated to point to the next ticket in the set, so this function can be called repeatedly with the same hint argument in order to find all tickets matching a certain criterium. Note that if tickets are added to, or removed from, the ticketset during a query with the same hint argument, the hint->startpos field must be updated appropriately.

HERE IS HOW YOU WOULD TYPICALLY USE THIS FUNCTION¶

Shishi_tkts_hint hint;

Shishi_tkt tkt;

memset(&hint, 0, sizeof(hint));

hint.server = "imap/mail.example.org";

tkt = shishi_tkts_find (shishi_tkts_default(handle), &hint);

if (!tkt)

printf("No ticket found...0);

else

do_something_with_ticket (tkt);

RETURN VALUE¶

Returns a ticket if found, or NULL if no further matching tickets could be found.

REPORTING BUGS¶

Report bugs to <bug-shishi@gnu.org>. GNU Shishi home page: http://www.gnu.org/software/shishi/ General help using GNU software: http://www.gnu.org/gethelp/

COPYRIGHT¶

Copyright © 2002-2022 Simon Josefsson.
Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved.

SEE ALSO¶

The full documentation for shishi is maintained as a Texinfo manual. If the info and shishi programs are properly installed at your site, the command

info shishi

should give you access to the complete manual.