From db74ccf95d89f1841d95bb8bd3839fc52a78d6c0 Mon Sep 17 00:00:00 2001 From: nyamatongwe Date: Tue, 6 Nov 2001 01:08:06 +0000 Subject: Extra documentation for feature numbering and string arguments. --- include/Scintilla.iface | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/include/Scintilla.iface b/include/Scintilla.iface index ab3c5b6ed..a2528adad 100644 --- a/include/Scintilla.iface +++ b/include/Scintilla.iface @@ -25,6 +25,9 @@ ## The syntax for evt is [=[,]*]) ## Feature names that contain an underscore are defined by Windows, so in these ## cases, using the Windows definition is preferred where available. +## The feature numbers are stable so features will not be renumbered. +## Features may be removed but they will go through a period of deprecation +## before removal which is signalled by moving them into the Deprecated category. ## Types: ## void @@ -49,6 +52,12 @@ ## Client code should ignore definitions containing types it does not understand, except ## for possibly #defining the constants +## String arguments may contain NUL ('\0') characters where the calls provide a length +## argument and retrieve NUL characters. All retrieved strings except for those retrieved +## by GetLine also have a NUL appended but client code should calculate the size that +## will be returned rather than relying upon the NUL whenever possible. Allow for the +## extra NUL character when allocating buffers. + cat Basics ################################################ -- cgit v1.2.3