diff options
| author | rdaneelolivaw <devnull@localhost> | 2005-06-04 02:15:19 +0000 | 
|---|---|---|
| committer | rdaneelolivaw <devnull@localhost> | 2005-06-04 02:15:19 +0000 | 
| commit | db1cf4a90d7176a0885fba3f3109fb35deba5b60 (patch) | |
| tree | 94b283c1bccffd48a3b8609aeb96ed18720d76ef | |
| parent | 0f23c0ae4a7c4dfedefc838f5b33936603926cd6 (diff) | |
| download | scintilla-mirror-db1cf4a90d7176a0885fba3f3109fb35deba5b60.tar.gz | |
RBR - Added descriptions for the GetProperty* functions from Robert Roessler.
| -rw-r--r-- | doc/ScintillaDoc.html | 34 | 
1 files changed, 33 insertions, 1 deletions
| diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index 5b5a606c1..d9ee3eadc 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -38,7 +38,7 @@      <h1>Scintilla Documentation</h1> -    <p>Last edited 7/May/2005 RBR</p> +    <p>Last edited 3/June/2005 RBR</p>      <p>There is <a class="jump" href="Design.html">an overview of the internal design of      Scintilla</a>.<br /> @@ -4287,6 +4287,9 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){      *path)</a><br />       <a class="message" href="#SCI_COLOURISE">SCI_COLOURISE(int start, int end)</a><br />       <a class="message" href="#SCI_SETPROPERTY">SCI_SETPROPERTY(const char *key, const char *value)</a><br /> +     <a class="message" href="#SCI_GETPROPERTY">SCI_GETPROPERTY(const char *key, char *value)</a><br /> +     <a class="message" href="#SCI_GETPROPERTYEXPANDED">SCI_GETPROPERTYEXPANDED(const char *key, char *value)</a><br /> +     <a class="message" href="#SCI_GETPROPERTYINT">SCI_GETPROPERTYINT(const char *key)</a><br />       <a class="message" href="#SCI_SETKEYWORDS">SCI_SETKEYWORDS(int keyWordSet, const char      *keyWordList)</a><br />      </code> @@ -4346,6 +4349,35 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){      interpreted as integers. Search the lexer sources for <code>GetPropertyInt</code> to see how      properties are used.</p> +    <p><b id="SCI_GETPROPERTY">SCI_GETPROPERTY(const char *key, char *value)</b><br /> +    Lookup a keyword:value pair using the specified key; if found, copy the value to the user-supplied +    buffer and return the length (not including the terminating 0).  If not found, copy an empty string +    to the buffer and return 0.</p> + +    <p>Note that  "keyword replacement" as described in <a class="message" href="#SCI_SETPROPERTY"> +    <code>SCI_SETPROPERTY</code></a> will not be performed.</p> + +    <p>If the value argument is 0 then the length that should be allocated to store the value is returned; +    again, the terminating 0 is not included.</p> + +    <p><b id="SCI_GETPROPERTYEXPANDED">SCI_GETPROPERTYEXPANDED(const char *key, char *value)</b><br /> +    Lookup a keyword:value pair using the specified key; if found, copy the value to the user-supplied +    buffer and return the length (not including the terminating 0).  If not found, copy an empty string +    to the buffer and return 0.</p> + +    <p>Note that  "keyword replacement" as described in <a class="message" href="#SCI_SETPROPERTY"> +    <code>SCI_SETPROPERTY</code></a> will be performed.</p> + +    <p>If the value argument is 0 then the length that should be allocated to store the value (including any indicated keyword replacement) +    is returned; again, the terminating 0 is not included.</p> + +    <p><b id="SCI_GETPROPERTYINT">SCI_GETPROPERTYINT(const char *key)</b><br /> +    Lookup a keyword:value pair using the specified key; if found, interpret the value as an integer and return it. +    If not found (or the value is not a number) then return 0.</p> + +    <p>Note that  "keyword replacement" as described in <a class="message" href="#SCI_SETPROPERTY"> +    <code>SCI_SETPROPERTY</code></a> will be performed before any numeric interpretation.</p> +      <p><b id="SCI_SETKEYWORDS">SCI_SETKEYWORDS(int keyWordSet, const char *keyWordList)</b><br />       You can set up to 9 lists of keywords for use by the current lexer. This was increased from 6      at revision 1.50. <code>keyWordSet</code> can be 0 to 8 (actually 0 to <code>KEYWORDSET_MAX</code>) | 
