diff options
| author | Neil <nyamatongwe@gmail.com> | 2016-11-01 20:13:43 +1100 |
|---|---|---|
| committer | Neil <nyamatongwe@gmail.com> | 2016-11-01 20:13:43 +1100 |
| commit | 06bb0e6af3335e11da31ac8096871831a5da6c39 (patch) | |
| tree | c576b6f49b716bb582bdad3e63bc116100060fdc | |
| parent | 72a8f19a7676114cc1c5ab4e593ca0a82d278fe0 (diff) | |
| download | scintilla-mirror-06bb0e6af3335e11da31ac8096871831a5da6c39.tar.gz | |
Clarify ConvertToDocument as there was some confusion on the mailing list.
| -rw-r--r-- | doc/ScintillaDoc.html | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index 333a7f865..87064b938 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -5582,8 +5582,9 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ <code>AddData</code> will return SC_STATUS_OK unless a failure, such as memory exhaustion occurs. If a failure occurs in <code>AddData</code> or in a file reading call then loading can be abandoned and the loader released with the <code>Release</code> call. - When the whole file has been read, the <code>ConvertToDocument</code> method should be called to produce a Scintilla - document pointer which can be used in the same way as a document pointer returned from + When the whole file has been read, <code>ConvertToDocument</code> should be called to produce a Scintilla + document pointer. The newly created document will have a reference count of 1 in the same way as a document pointer + returned from <a class="seealso" href="#SCI_CREATEDOCUMENT">SCI_CREATEDOCUMENT</a>. There is no need to call <code>Release</code> after <code>ConvertToDocument</code>.</p> |