THotPDF.ExtractLoadedPagesTextToStream Method

Writes loaded page text as UTF-8 to a caller-owned stream while retaining only one page of Unicode text in memory

Declaration

function ExtractLoadedPagesTextToStream(Stream: TStream; const PageRange: string= ''; const PageSeparator: UnicodeString= #12; WriteBOM: boolean= False): Integer;

Parameters

• Stream receives UTF-8 bytes at its current position
• PageRange accepts the loaded-document one-based range syntax; an empty value selects every page
• PageSeparator is encoded between selected pages
• WriteBOM emits a UTF-8 BOM when at least one page is selected

Return value

Returns the number of selected pages whose text was extracted successfully