[#OSSL_PARAM_get_octet_string]
= OSSL_PARAM_get_octet_string
:mrdocs:

Copy an OSSL_PARAM octet‐string value into a caller buffer.

== Synopsis

Declared in `<openssl/params.h>`

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

== Return Value

1 on success, or 0 on error.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *p*
| Parameter locating the octet string.
| *val*
| Address of a buffer pointer that receives up to `max_len` bytes; may allocate when *`val` is NULL depending on call pattern.
| *max_len*
| Capacity of the destination buffer in bytes.
| *used_len*
| Optional output set to the number of bytes copied or required.
|===


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