ASN1_OBJECT_new.3ossl 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  1. .\" -*- mode: troff; coding: utf-8 -*-
  2. .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
  3. .\"
  4. .\" Standard preamble:
  5. .\" ========================================================================
  6. .de Sp \" Vertical space (when we can't use .PP)
  7. .if t .sp .5v
  8. .if n .sp
  9. ..
  10. .de Vb \" Begin verbatim text
  11. .ft CW
  12. .nf
  13. .ne \\$1
  14. ..
  15. .de Ve \" End verbatim text
  16. .ft R
  17. .fi
  18. ..
  19. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
  20. .ie n \{\
  21. . ds C` ""
  22. . ds C' ""
  23. 'br\}
  24. .el\{\
  25. . ds C`
  26. . ds C'
  27. 'br\}
  28. .\"
  29. .\" Escape single quotes in literal strings from groff's Unicode transform.
  30. .ie \n(.g .ds Aq \(aq
  31. .el .ds Aq '
  32. .\"
  33. .\" If the F register is >0, we'll generate index entries on stderr for
  34. .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  35. .\" entries marked with X<> in POD. Of course, you'll have to process the
  36. .\" output yourself in some meaningful fashion.
  37. .\"
  38. .\" Avoid warning from groff about undefined register 'F'.
  39. .de IX
  40. ..
  41. .nr rF 0
  42. .if \n(.g .if rF .nr rF 1
  43. .if (\n(rF:(\n(.g==0)) \{\
  44. . if \nF \{\
  45. . de IX
  46. . tm Index:\\$1\t\\n%\t"\\$2"
  47. ..
  48. . if !\nF==2 \{\
  49. . nr % 0
  50. . nr F 2
  51. . \}
  52. . \}
  53. .\}
  54. .rr rF
  55. .\" ========================================================================
  56. .\"
  57. .IX Title "ASN1_OBJECT_NEW 3ossl"
  58. .TH ASN1_OBJECT_NEW 3ossl 2025-01-17 3.4.0 OpenSSL
  59. .\" For nroff, turn off justification. Always turn off hyphenation; it makes
  60. .\" way too many mistakes in technical documents.
  61. .if n .ad l
  62. .nh
  63. .SH NAME
  64. ASN1_OBJECT_new, ASN1_OBJECT_free \- object allocation functions
  65. .SH SYNOPSIS
  66. .IX Header "SYNOPSIS"
  67. .Vb 1
  68. \& #include <openssl/asn1.h>
  69. \&
  70. \& ASN1_OBJECT *ASN1_OBJECT_new(void);
  71. \& void ASN1_OBJECT_free(ASN1_OBJECT *a);
  72. .Ve
  73. .SH DESCRIPTION
  74. .IX Header "DESCRIPTION"
  75. The \fBASN1_OBJECT\fR allocation routines, allocate and free an
  76. \&\fBASN1_OBJECT\fR structure, which represents an ASN1 OBJECT IDENTIFIER.
  77. .PP
  78. \&\fBASN1_OBJECT_new()\fR allocates and initializes an \fBASN1_OBJECT\fR structure.
  79. .PP
  80. \&\fBASN1_OBJECT_free()\fR frees up the \fBASN1_OBJECT\fR structure \fIa\fR.
  81. If \fIa\fR is NULL, nothing is done.
  82. .SH NOTES
  83. .IX Header "NOTES"
  84. Although \fBASN1_OBJECT_new()\fR allocates a new \fBASN1_OBJECT\fR structure it
  85. is almost never used in applications. The ASN1 object utility functions
  86. such as \fBOBJ_nid2obj()\fR are used instead.
  87. .SH "RETURN VALUES"
  88. .IX Header "RETURN VALUES"
  89. If the allocation fails, \fBASN1_OBJECT_new()\fR returns NULL and sets an error
  90. code that can be obtained by \fBERR_get_error\fR\|(3).
  91. Otherwise it returns a pointer to the newly allocated structure.
  92. .PP
  93. \&\fBASN1_OBJECT_free()\fR returns no value.
  94. .SH "SEE ALSO"
  95. .IX Header "SEE ALSO"
  96. \&\fBERR_get_error\fR\|(3), \fBd2i_ASN1_OBJECT\fR\|(3)
  97. .SH COPYRIGHT
  98. .IX Header "COPYRIGHT"
  99. Copyright 2002\-2016 The OpenSSL Project Authors. All Rights Reserved.
  100. .PP
  101. Licensed under the Apache License 2.0 (the "License"). You may not use
  102. this file except in compliance with the License. You can obtain a copy
  103. in the file LICENSE in the source distribution or at
  104. <https://www.openssl.org/source/license.html>.