doc/man3/ASN1_OBJECT_new.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 ASN1_OBJECT_new, ASN1_OBJECT_free - object allocation functions
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/asn1.h>
  10
  11  ASN1_OBJECT *ASN1_OBJECT_new(void);
  12  void ASN1_OBJECT_free(ASN1_OBJECT *a);
  13
  14 =head1 DESCRIPTION
  15
  16 The ASN1_OBJECT allocation routines, allocate and free an
  17 ASN1_OBJECT structure, which represents an ASN1 OBJECT IDENTIFIER.
  18
  19 ASN1_OBJECT_new() allocates and initializes an ASN1_OBJECT structure.
  20
  21 ASN1_OBJECT_free() frees up the B<ASN1_OBJECT> structure B<a>.
  22 If B<a> is NULL, nothing is done.
  23
  24 =head1 NOTES
  25
  26 Although ASN1_OBJECT_new() allocates a new ASN1_OBJECT structure it
  27 is almost never used in applications. The ASN1 object utility functions
  28 such as OBJ_nid2obj() are used instead.
  29
  30 =head1 RETURN VALUES
  31
  32 If the allocation fails, ASN1_OBJECT_new() returns B<NULL> and sets an error
  33 code that can be obtained by L<ERR_get_error(3)>.
  34 Otherwise it returns a pointer to the newly allocated structure.
  35
  36 ASN1_OBJECT_free() returns no value.
  37
  38 =head1 SEE ALSO
  39
  40 L<ERR_get_error(3)>, L<d2i_ASN1_OBJECT(3)>
  41
  42 =head1 COPYRIGHT
  43
  44 Copyright 2002-2016 The OpenSSL Project Authors. All Rights Reserved.
  45
  46 Licensed under the OpenSSL license (the "License").  You may not use
  47 this file except in compliance with the License.  You can obtain a copy
  48 in the file LICENSE in the source distribution or at
  49 L<https://www.openssl.org/source/license.html>.
  50
  51 =cut