[#OSSL_PARAM_get_utf8_string]
= OSSL_PARAM_get_utf8_string
:mrdocs:

Copy a UTF‐8 string OSSL_PARAM into a caller‐provided or allocated buffer.

== Synopsis

Declared in `<openssl/params.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
OSSL_PARAM_get_utf8_string(
    xref:OSSL_PARAM.adoc[OSSL_PARAM] const* p,
    char** val,
    size_t max_len);
----

== Return Value

1 on success, or 0 on failure.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *p*
| Parameter of type OSSL_PARAM_UTF8_STRING.
| *val*
| When *`val` is NULL, receives a newly allocated copy; otherwise writes into the buffer of size `max_len.`
| *max_len*
| Capacity of *`val` when non‐NULL (including space for the NUL); ignored when allocating.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#