Add help text for keyd
[onak.git] / photoid.h
1 /*
2  * photoid.h - Routines for OpenPGP id photos.
3  *
4  * Jonathan McDowell <noodles@earth.li>
5  *
6  * Copyright 2004 Project Purple
7  */
8
9 #ifndef __PHOTOID_H__
10 #define __PHOTOID_H__
11
12 #include "keystructs.h"
13
14 /**
15  *      getphoto - returns an OpenPGP packet containing a photo id.
16  *      @key: The key to return the photo id from.
17  *      @index: The index of the photo to return.
18  *      @photo: The photo data.
19  *      @length: The length of the photo data.
20  *
21  *      This function returns the photo data contained in a supplied key.
22  *      index specifies which photo id should be returned. If there's no such
23  *      photo id NULL is returned. The returned data pointer refers to the key
24  *      data supplied rather than a copy of it.
25  */
26 int getphoto(struct openpgp_publickey *key, int index, unsigned char **photo,
27                 size_t *length);
28
29 #endif /* __PHOTOID_H__ */