Function sequoia_ffi::openpgp::packet::userid::pgp_user_id_comment[][src]

#[no_mangle]
pub extern "C" fn pgp_user_id_comment(
    errp: Option<&mut *mut Error>,
    uid: *const Packet,
    commentp: &mut *mut c_char
) -> Status
Expand description

Returns the User ID’s comment field, if any.

C Declaration

pgp_status_t
pgp_user_id_comment (pgp_error_t *errp,
                     const pgp_packet_t uid,
                     char **commentp);

The User ID is parsed according to de facto convention, and the comment field is extracted.

If the User ID cannot be parsed, then an error is returned.

If the User ID does not contain a comment, *commentp is set to NULL.