openssl/doc/man3/PKCS12_add_friendlyname_asc.pod
Jon Spillett eb389a75c0 Add missing docs for some PKCS12 functions
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/9752)
2019-11-12 18:14:31 +01:00

53 lines
1.5 KiB
Plaintext

=pod
=head1 NAME
PKCS12_add_friendlyname_asc, PKCS12_add_friendlyname_utf8,
PKCS12_add_friendlyname_uni - Functions to add the friendlyname attribute to a
PKCS#12 safeBag
=head1 SYNOPSIS
#include <openssl/pkcs12.h>
int PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, const char *name,
int namelen);
int PKCS12_add_friendlyname_utf8(PKCS12_SAFEBAG *bag, const char *name,
int namelen);
int PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag,
const unsigned char *name, int namelen);
=head1 DESCRIPTION
PKCS12_add_friendlyname_asc() adds an ASCII string representation of the PKCS#9
friendlyName attribute to a PKCS#12 safeBag.
PKCS12_add_friendlyname_utf8() adds a UTF-8 string representation of the PKCS#9
friendlyName attribute to a PKCS#12 safeBag.
PKCS12_add_friendlyname_uni() adds a Unicode string representation of the PKCS#9
friendlyName attribute to a PKCS#12 safeBag.
I<bag> is the B<PKCS12_SAFEBAG> to add the attribute to.
=head1 RETURN VALUES
Returns 1 for success or 0 for failure.
=head1 SEE ALSO
L<PKCS12_get_friendlyname(3)>
=head1 COPYRIGHT
Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the Apache License 2.0 (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.
=cut