X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/038809c2f657f03d8688d7a75ca416878dfa0de7..7344108e8a129a3f9b4df5ab0f98a1713db03b89:/interface/wx/convauto.h diff --git a/interface/wx/convauto.h b/interface/wx/convauto.h index 715d06c279..d4d3919c4d 100644 --- a/interface/wx/convauto.h +++ b/interface/wx/convauto.h @@ -147,6 +147,26 @@ public: */ wxBOM GetBOM() const; + /** + Return a pointer to the characters that makes up this BOM. + + The returned character count is 2, 3 or 4, or undefined if the return + value is NULL. + + @param bom + A valid BOM type, i.e. not wxBOM_Unknown or wxBOM_None. + @param count + A non-@NULL pointer receiving the number of characters in this BOM. + @return + Pointer to characters composing the BOM or @NULL if BOM is unknown + or invalid. Notice that the returned string is not NUL-terminated + and may contain embedded NULs so @a count must be used to handle it + correctly. + + @since 2.9.3 + */ + const char* GetBOMChars(wxBOM bom, size_t* count); + /** Disable the use of the fall back encoding: if the input doesn't have a BOM and is not valid UTF-8, the conversion will fail.