synchronize GTK2 minimum version in docs

[wxWidgets.git] / interface / wx / convauto.h

diff --git a/interface/wx/convauto.h b/interface/wx/convauto.h
index 715d06c279e09daff2b8518c7f38917eb1ef9259..d4d3919c4d5d84f72733702b7937077e18d47079 100644 (file)
--- 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.