mirror of
https://github.com/openssl/openssl.git
synced 2024-12-21 06:09:35 +08:00
723e9c8983
Details from man-pages(7) that are used:
Formatting conventions for manual pages describing functions
...
Variable names should, like argument names, be specified in italics.
...
Formatting conventions (general)
...
Special macros, which are usually in uppercase, are in bold.
Exception: don't boldface NULL.
...
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/10042)
53 lines
1.2 KiB
Plaintext
53 lines
1.2 KiB
Plaintext
=pod
|
|
|
|
=head1 NAME
|
|
|
|
ASN1_STRING_new, ASN1_STRING_type_new, ASN1_STRING_free -
|
|
ASN1_STRING allocation functions
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
#include <openssl/asn1.h>
|
|
|
|
ASN1_STRING * ASN1_STRING_new(void);
|
|
ASN1_STRING * ASN1_STRING_type_new(int type);
|
|
void ASN1_STRING_free(ASN1_STRING *a);
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
ASN1_STRING_new() returns an allocated B<ASN1_STRING> structure. Its type
|
|
is undefined.
|
|
|
|
ASN1_STRING_type_new() returns an allocated B<ASN1_STRING> structure of
|
|
type I<type>.
|
|
|
|
ASN1_STRING_free() frees up I<a>.
|
|
If I<a> is NULL nothing is done.
|
|
|
|
=head1 NOTES
|
|
|
|
Other string types call the B<ASN1_STRING> functions. For example
|
|
ASN1_OCTET_STRING_new() calls ASN1_STRING_type(V_ASN1_OCTET_STRING).
|
|
|
|
=head1 RETURN VALUES
|
|
|
|
ASN1_STRING_new() and ASN1_STRING_type_new() return a valid
|
|
B<ASN1_STRING> structure or NULL if an error occurred.
|
|
|
|
ASN1_STRING_free() does not return a value.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<ERR_get_error(3)>
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2002-2016 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
|