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)
52 lines
1.3 KiB
Plaintext
52 lines
1.3 KiB
Plaintext
=pod
|
|
|
|
=head1 NAME
|
|
|
|
ASN1_OBJECT_new, ASN1_OBJECT_free - object allocation functions
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
#include <openssl/asn1.h>
|
|
|
|
ASN1_OBJECT *ASN1_OBJECT_new(void);
|
|
void ASN1_OBJECT_free(ASN1_OBJECT *a);
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The B<ASN1_OBJECT> allocation routines, allocate and free an
|
|
B<ASN1_OBJECT> structure, which represents an ASN1 OBJECT IDENTIFIER.
|
|
|
|
ASN1_OBJECT_new() allocates and initializes an B<ASN1_OBJECT> structure.
|
|
|
|
ASN1_OBJECT_free() frees up the B<ASN1_OBJECT> structure I<a>.
|
|
If I<a> is NULL, nothing is done.
|
|
|
|
=head1 NOTES
|
|
|
|
Although ASN1_OBJECT_new() allocates a new B<ASN1_OBJECT> structure it
|
|
is almost never used in applications. The ASN1 object utility functions
|
|
such as OBJ_nid2obj() are used instead.
|
|
|
|
=head1 RETURN VALUES
|
|
|
|
If the allocation fails, ASN1_OBJECT_new() returns NULL and sets an error
|
|
code that can be obtained by L<ERR_get_error(3)>.
|
|
Otherwise it returns a pointer to the newly allocated structure.
|
|
|
|
ASN1_OBJECT_free() returns no value.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<ERR_get_error(3)>, L<d2i_ASN1_OBJECT(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
|