ASN1_STRING_print_ex (3)

Leading comments

Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/ASN1_STRING_print_ex.3ssl".)

NAME

ASN1_STRING_print_ex, ASN1_STRING_print_ex_fp, ASN1_STRING_print - ASN1_STRING output routines.

SYNOPSIS

 #include <openssl/asn1.h>

 int ASN1_STRING_print_ex(BIO *out, ASN1_STRING *str, unsigned long flags);
 int ASN1_STRING_print_ex_fp(FILE *fp, ASN1_STRING *str, unsigned long flags);
 int ASN1_STRING_print(BIO *out, ASN1_STRING *str);

DESCRIPTION

These functions output an structure. is used to represent all the string types.

ASN1_STRING_print_ex() outputs str to out, the format is determined by the options flags. ASN1_STRING_print_ex_fp() is identical except it outputs to fp instead.

ASN1_STRING_print() prints str to out but using a different format to ASN1_STRING_print_ex(). It replaces unprintable characters (other than

) with '.'.

NOTES

ASN1_STRING_print() is a legacy function which should be avoided in new applications.

Although there are a large number of options frequently

is suitable, or on terminals ~ASN1_STRFLGS_ESC_MSB.

The complete set of supported options for flags is listed below.

Various characters can be escaped. If

is set the characters determined by are escaped. If is set control characters are escaped. If is set characters with the set are escaped: this option should not be used if the terminal correctly interprets sequences.

Escaping takes several forms.

If the character being escaped is a 16 bit character then the form ``\UXXXX'' is used using exactly four characters for the hex representation. If it is 32 bits then ``\WXXXXXXXX'' is used using eight characters of its hex representation. These forms will only be used if

conversion is not set (see below).

Printable characters are normally escaped using the backslash '\' character. If

is set then the whole string is instead surrounded by double quote characters: this is arguably more readable than the backslash notation. Other characters use the ``\XX'' using exactly two characters of the hex representation.

If

is set then characters are converted to format first. If the terminal supports the display of sequences then this option will correctly display multi byte characters.

If

is set then the string type is not interpreted at all: everything is assumed to be one byte per character. This is primarily for debugging purposes and can result in confusing output in multi character strings.

If

is set then the string type itself is printed out before its value (for example ``), this actually uses ASN1_tag2str().

The content of a string instead of being interpreted can be ``dumped'': this just outputs the value of the string using the form #XXXX using hex format for each octet.

If

is set then any type is dumped.

Normally non character string types (such as

) are assumed to be one byte per character, if is set then they will be dumped instead.

When a type is dumped normally just the content octets are printed, if

is set then the complete encoding is dumped instead (including tag and length octets).

includes all the flags required by It is equivalent to:
  |  |  |
  | 

SEE ALSO

X509_NAME_print_ex(3), ASN1_tag2str(3)

HISTORY