ASN1_STRING_new.3ossl 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105
  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_STRING_NEW 3ossl"
  58. .TH ASN1_STRING_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_STRING_new, ASN1_STRING_type_new, ASN1_STRING_free \-
  65. ASN1_STRING allocation functions
  66. .SH SYNOPSIS
  67. .IX Header "SYNOPSIS"
  68. .Vb 1
  69. \& #include <openssl/asn1.h>
  70. \&
  71. \& ASN1_STRING *ASN1_STRING_new(void);
  72. \& ASN1_STRING *ASN1_STRING_type_new(int type);
  73. \& void ASN1_STRING_free(ASN1_STRING *a);
  74. .Ve
  75. .SH DESCRIPTION
  76. .IX Header "DESCRIPTION"
  77. \&\fBASN1_STRING_new()\fR returns an allocated \fBASN1_STRING\fR structure. Its type
  78. is undefined.
  79. .PP
  80. \&\fBASN1_STRING_type_new()\fR returns an allocated \fBASN1_STRING\fR structure of
  81. type \fItype\fR.
  82. .PP
  83. \&\fBASN1_STRING_free()\fR frees up \fIa\fR.
  84. If \fIa\fR is NULL nothing is done.
  85. .SH NOTES
  86. .IX Header "NOTES"
  87. Other string types call the \fBASN1_STRING\fR functions. For example
  88. \&\fBASN1_OCTET_STRING_new()\fR calls ASN1_STRING_type_new(V_ASN1_OCTET_STRING).
  89. .SH "RETURN VALUES"
  90. .IX Header "RETURN VALUES"
  91. \&\fBASN1_STRING_new()\fR and \fBASN1_STRING_type_new()\fR return a valid
  92. \&\fBASN1_STRING\fR structure or NULL if an error occurred.
  93. .PP
  94. \&\fBASN1_STRING_free()\fR does not return a value.
  95. .SH "SEE ALSO"
  96. .IX Header "SEE ALSO"
  97. \&\fBERR_get_error\fR\|(3)
  98. .SH COPYRIGHT
  99. .IX Header "COPYRIGHT"
  100. Copyright 2002\-2023 The OpenSSL Project Authors. All Rights Reserved.
  101. .PP
  102. Licensed under the Apache License 2.0 (the "License"). You may not use
  103. this file except in compliance with the License. You can obtain a copy
  104. in the file LICENSE in the source distribution or at
  105. <https://www.openssl.org/source/license.html>.