Article # 498, added by Geoworks, historical record
| first |
previous |
index |
next |
last |
API for the FoamDocConvert.. routines.
The Foam library routines are documented in HTML format. Please see http://www.geoworks.com/devrel/sdk-doc/Routines/index.html for these routines. But while you're here, check out these descriptions. FoamDocConvertFromDosInit: SYNOPSIS: Initialize the DOS to document conversion. The function returns an optr of a temporary text object used in the conversion. PASS: void RETURN: optr - temorary text object. SIDE FX: none FoamDocConvertFromDosAppend SYNOPSIS: Append a buffer of DOS text to the temporary text object. The DOS text is converted to the GEOS character set; CR's and Ctrl-Z are removed. PASS: optr object - temporary text object TCHAR * buffer - fptr to buffer of text to append word bufferLength - number of characters to append. (0 if null-terminated). RETURN: void SIDE FX: none FoamDocConvertFromDosDone SYNOPSIS: Function is called when done appending to the temporary text object. A text transfer item is created from the text object and stored in the specified document. The text object is then destroyed. PASS: DocumentHandle docHandle - DocumentHandle optr object - Temporary text object RETURN: void SIDE FX: none FoamDocConvertToDosInit SYNOPSIS: Initializes the Document to Dos conversion, returning an optr of a temporary text object used in the conversion. All calls to FoamDocConvertToDosInit must be offset by a call to FoamDocConvertToDosDone. PASS: DocumentHandle docHandle - DocumentHandle RETURN: optr - Temporary text object SIDE FX: none FoamDocConvertToDosRange SYNOPSIS: Retrieve a range of text from the document into a specified buffer. The buffer must be able to hold the number of bytes requested. The call is responsible for making sure this is the case. The buffer must be at least TWICE as large as the size of data requested. That means, if you want to get 1K data, the buffer allocated should be able to hold 2K data beginning at ES:DI. PASS: optr object - Text object TCHAR * buffer - fptr of buffer for text dword startPos - start position dword endPos - end position RETURN: word - number of characters returned. SIDE FX: none FoamDocConvertToDosDone SYNOPSIS: Function is called when done retrieving text from the temporary text object. PASS: optr object - Temporary text object. RETURN: void SIDE FX: none