From 06bb0e6af3335e11da31ac8096871831a5da6c39 Mon Sep 17 00:00:00 2001 From: Neil Date: Tue, 1 Nov 2016 20:13:43 +1100 Subject: Clarify ConvertToDocument as there was some confusion on the mailing list. --- doc/ScintillaDoc.html | 5 +++-- 1 file 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){ AddData will return SC_STATUS_OK unless a failure, such as memory exhaustion occurs. If a failure occurs in AddData or in a file reading call then loading can be abandoned and the loader released with the Release call. - When the whole file has been read, the ConvertToDocument 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, ConvertToDocument 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 SCI_CREATEDOCUMENT. There is no need to call Release after ConvertToDocument.

-- cgit v1.2.3