mirror of
https://github.com/wxWidgets/wxWidgets.git
synced 2026-09-23 06:33:59 +08:00
Expand wxSecureZeroMemory docs
Give examples of how it may be implemented. Format it into a doxygen @note block. Closes #24665.
This commit is contained in:
committed by
Vadim Zeitlin
parent
c8e221d3ee
commit
fed7de961e
@@ -346,9 +346,13 @@ bool wxGetEnvMap(wxEnvVariableHashMap *map);
|
||||
@param p Pointer to the memory block to be zeroed, must be non-null.
|
||||
@param n The number of bytes to zero.
|
||||
|
||||
NOTE: If security is vitally important in your use case, please
|
||||
@note If security is vitally important in your use case, please
|
||||
have a look at the implementations and decide whether you trust
|
||||
them to behave as promised.
|
||||
them to behave as promised. Depending on the platform and available libraries,
|
||||
this may be implemented as `RtlSecureZeroMemory` (MS Windows),
|
||||
`explicit_bzero()` (FreeBSD), `memset_s()` (macOS),
|
||||
or a generic method which uses `volatile` to avoid the call from
|
||||
being optimized away.
|
||||
|
||||
@header{wx/utils.h}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user