[#memory_cleanse]
= memory_cleanse
:mrdocs:

Secure overwrite a buffer (possibly containing secret data) with zero‐bytes. The write operation will not be optimized out by the compiler.

== Synopsis

Declared in `<support/cleanse.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
void
memory_cleanse(
    void* ptr,
    size_t len);
----

== Parameters

[cols="1,4"]
|===
| Name| Description
| *ptr*
| Pointer to the start of the buffer to overwrite.
| *len*
| Number of bytes to overwrite with zeros.
|===


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