diff --git a/apdfl18/CPlusPlus/APDFL18.0.4PlusP2y/dlextras_General.html b/apdfl18/CPlusPlus/APDFL18.0.4PlusP2y/dlextras_General.html deleted file mode 100644 index e91c6990..00000000 --- a/apdfl18/CPlusPlus/APDFL18.0.4PlusP2y/dlextras_General.html +++ /dev/null @@ -1,404 +0,0 @@ - - - - - - - - -Additional functionality from Datalogics: General - - - - -
-DL Logo -
-
-
-
-
-

General Definitions

- -

FOUR_CHAR_CODE

- -
Header: DLExtrasExpT.h:16
-
- -

Syntax

- -#define FOUR_CHAR_CODE ( x )( x ) -
-
-
-

General Enumerations

- -

AC_OptionCode

- -
Header: DLExtrasExpT.h:22
-
- -

Description

- -
Datalogics-specific flags for the Acro Color Layer.
-
- -

Enum Constants

- - - -
AC_Option_BlackPointCompensation=FOUR_CHAR_CODE('kptc')
-
Controls whether to adjust for differences in black points when converting colors between color spaces. If enabled the full dynamic range of the source space is mapped into the full dynamic range of the destination space. If disabled, the dynamic range of the source space is simulated in the destination space (which can result in blocked or gray shadows) This option is ignored if the rendering intent for the transformation is AC_AbsColorimetric. Default is 0 (zero).
-
AC_Option_Dither8=FOUR_CHAR_CODE('dth8')
-
Dither transformations to 8 bit color spaces. This may be ignored by optimized transforms. This option is used by AC_ApplyTransform. Default is 0 (zero).
-
AC_OptionCode_MaxEnum=0xFFFFFFFFL
-
-
- -

Used By

- - -
-

FontRescanFlags

- -
Header: DLExtrasExpT.h:73
-
- -

Description

- -
flags for rescanning font directories for additional fonts after Library initialization.
-
- -

Enum Constants

- - - -
FontRescan_Files=1
-
This will rescan just the fields defined in dirList, plus those added with PDFLAddFontDirectories.
-
FontRescan_System=2
-
This will rescan the system directories.
-
FontRescan_All=3
-
This, or an "or" of the previous two, will rescan both.
-
- -

Used By

- - -
-
-
-

General Functions

- -

ACGetOption

- -
Header: DLExtrasProcs.h:129
-
- -

Description

- -
Returns the current value for the given AC_OptionCode. This call controls the behavior of colorspace conversions and manipulations carried out via AC-layer calls; it does not impact other Adobe PDF Library color behaviors.
-
- -

Related Methods

- - -
-
- -

Syntax

- -AC_Error ACGetOption(AC_OptionCode code, ASUns32 *value); - -

Parameters

- - -
code
-
AC_Option_BlackPointCompensation indicates whether the Acrobat Color Engine will carry out black point compensation when converting between colorspaces with different black points.
-
value
-
AC_Option_BlackPointCompensation flag value to be retrieved (Filled by the method)
-
- -

Returns

- -
Indicates if an error occurred.
-
-

ACSetOption

- -
Header: DLExtrasProcs.h:140
-
- -

Description

- -
Sets the current value for the option specified by the supplied AC_OptionCode. This call controls the behavior of colorspace conversions and manipulations carried out via AC-layer calls; it does not impact other Adobe PDF Library color behaviors.
-
- -

Related Methods

- - -
-
- -

Syntax

- -AC_Error ACSetOption(AC_OptionCode code, ASUns32 value); - -

Parameters

- - -
The
-
option code.
-
value
-
The flag value to be set.
-
- -

Returns

- -
Indicates if an error occurred.
-
-

ASSetDefaultFileSys

- -
Header: DLExtrasProcs.h:19
-
- -

Description

- -
Sets the default file system implementation for a platform. Added by Datalogics.
-
- -

Related Methods

- -ASGetDefaultFileSys -ASGetRamFileSys -ASGetTempFileSys
-
- -

Syntax

- -void ASSetDefaultFileSys(ASFileSys fileSys); - -

Parameters

- -
fileSys
-
Alternate file system to be used
-
-
-

ConvertPDFToExcel

- -
Header: DLExtrasProcs.h:1049
-
- -

Description

- -
Converts a PDF file from the specified file path to a Microsoft Excel document (.xlsx) at the specified file path.
-
- -

Syntax

- -ASBool ConvertPDFToExcel(ASPathName inputPath, ASPathName outputPath, ASFileSys fileSys); - -

Parameters

- - - -
inputPath
-
The input path of the PDF document.
-
outputPath
-
The output path of the Office document.
-
fileSys
-
The File System in use.
-
- -

Returns

- -
if True, the Conversion was successful.
-
-

ConvertPDFToPowerPoint

- -
Header: DLExtrasProcs.h:1060
-
- -

Description

- -
Converts a PDF file from the specified file path to a Microsoft Powerpoint document (.pptx) at the specified file path.
-
- -

Syntax

- -ASBool ConvertPDFToPowerPoint(ASPathName inputPath, ASPathName outputPath, ASFileSys fileSys); - -

Parameters

- - - -
inputPath
-
The input path of the PDF document.
-
outputPath
-
The output path of the Office document.
-
fileSys
-
The File System in use.
-
- -

Returns

- -
if True, the Conversion was successful.
-
-

ConvertPDFToWord

- -
Header: DLExtrasProcs.h:1038
-
- -

Description

- -
Converts a PDF file from the specified file path to a Microsoft Word document (.docx) at the specified file path.
-
- -

Syntax

- -ASBool ConvertPDFToWord(ASPathName inputPath, ASPathName outputPath, ASFileSys fileSys); - -

Parameters

- - - -
inputPath
-
The input path of the PDF document.
-
outputPath
-
The output path of the Office document.
-
fileSys
-
The File System in use.
-
- -

Returns

- -
if True, the Conversion was successful.
-
-

DLEnableLicensedBehavior

- -
Header: DLExtrasProcs.h:21
-
- -

Syntax

- -ASBool DLEnableLicensedBehavior(const char *keyVal, const char *additionalInfo); -
-

PDFLAddFontDirectories

- -
Header: DLExtrasProcs.h:457
-
- -

Description

- -

This call allows Adobe PDF Library to rescan for fonts without re-initializing. This will allow an operating Library process to detect and update new font directories and resources after startup, without requiring a restart and re-initialization.
-

This will add one or more directories, and the fonts within them, to the set of all directories containing fonts (those specified in the DirList string arrays of resource locations).

- -

-

This call should be followed by a call to PDFLRescanFontDirectories after all new font directories have been loaded.

-
-
- -

Related Methods

- - -
-
- -

Syntax

- -ASBool PDFLAddFontDirectories(ASInt32 pathCount, ASPathName *paths); - -

Parameters

- - -
pathCount
-
Number of new paths to be added.
-
paths
-
Paths to new resource locations to be added.
-
- -

Returns

- -
Indicates if fonts directories were changed.
-
-

PDFLReinit

- -
Header: PDFLProcs.h:692
-
- -

Description

- -
Warm reinitialization of the Adobe PDF Library. Call this method if you closed all documents and other PD/PDE/Cos objects. Releases memory used for cached data.
-
- -

Syntax

- -ASInt32 PDFLReinit(void); -
-

PDFLRescanFontDirectories

- -
Header: DLExtrasProcs.h:443
-
- -

Description

- -

This call allows Adobe PDF Library to rescan for fonts without re-initializing. This will allow an operating Library process to detect and update new font directories and resources after startup, without requiring a restart and re-initialization.
-

This call can, depending on flag settings, force a rescan of font resource areas defined in your dirList array, a rescan of those residing in the System folder, or both. To add new font resources to your dirList array, use the PDFLAddFontDirectories call.

-
-
- -

Related Methods

- - -
-
- -

Syntax

- -ASBool PDFLRescanFontDirectories(FontRescanFlags flags); - -

Parameters

- -
flags
-
Flags controlling rescan process.
-
- -

Returns

- -
Indicates if fonts directories were changed.
-
-
- -
- - - \ No newline at end of file diff --git a/apdfl18/CPlusPlus/APDFL18.0.4PlusP2y/pdfllayer_PDFontDownloadContext.html b/apdfl18/CPlusPlus/APDFL18.0.4PlusP2y/pdfllayer_PDFontDownloadContext.html deleted file mode 100644 index 1da3f6bb..00000000 --- a/apdfl18/CPlusPlus/APDFL18.0.4PlusP2y/pdfllayer_PDFontDownloadContext.html +++ /dev/null @@ -1,98 +0,0 @@ - - - - - - - - -PDFL Library Layer: PDFontDownloadContext - - - - -
-DL Logo -
-
-
-
-
-

PDFontDownloadContext Functions

- -

PDFontDownloadContextCreate

- -
Header: PDFLProcs.h:267
-
- -

Description

- -
Creates a font download context object. This object keeps track of the fonts downloaded during a print job and whether substitution fonts have already been downloaded. It also tracks the font download parameters, such as binaryOK and 'emit TrueType as Type 42'. It is meant for use in the PDFontStreamPS() method.
-
- -

Related Methods

- -PDDocPrintPages -PDFontDownloadContextDestroy -PDFontStreamPS
-
- -

Syntax

- -PDFontDownloadContext PDFontDownloadContextCreate(PDPrintClient client); - -

Parameters

- -
client
-
The client record to pass to PDDocPrintPages().
-
- -

Returns

- -
The newly-created context.
-
-

PDFontDownloadContextDestroy

- -
Header: PDFLProcs.h:276
-
- -

Description

- -
Destroys a font download context object. Call this method after PDDocPrintPages() returns.
-
- -

Related Methods

- -PDDocPrintPages -PDFontDownloadContextCreate
-
- -

Syntax

- -void PDFontDownloadContextDestroy(PDFontDownloadContext context); - -

Parameters

- -
context
-
IN/OUT The context to destroy.
-
-
-
- -
- - - \ No newline at end of file diff --git a/apdfl18/CPlusPlus/APDFL18.0.4PlusP2y/pdlayer_PDPageLabel.html b/apdfl18/CPlusPlus/APDFL18.0.4PlusP2y/pdlayer_PDPageLabel.html deleted file mode 100644 index 161553a9..00000000 --- a/apdfl18/CPlusPlus/APDFL18.0.4PlusP2y/pdlayer_PDPageLabel.html +++ /dev/null @@ -1,476 +0,0 @@ - - - - - - - - -PD Layer: PDPageLabel - - - - -
-DL Logo -
-
-
-
-
-

PDPageLabel Typedefs

- -

PDPageLabel

- -
Header: PDExpT.h:5548
-
- -

Description

- -
A label used to describe a page. This is used to allow for non-sequential page numbering or the addition of arbitrary labels for a page (such as the inclusion of Roman numerals at the beginning of a book). A PDPageLabel specifies the numbering style to use (for example, upper-case or lower-case Roman, decimal, and so on), the starting number for the first page, and an arbitrary prefix to be preappended to each number (for example, "A-" is used to generate "A-1", "A-2", "A-3", and so on).
-
- -

Related Methods

- -PDDocGetLabelForPageNum -PDDocRemovePageLabel
-
- -

Syntax

- -typedef OPAQUE_64_BITS PDPageLabel; - -

Returned From

- - - -

Used By

- - -
-
-
-

PDPageLabel Functions

- -

PDPageLabelEqual

- -
Header: PDProcs.h:7155
-
- -

Description

- -
Compares two page labels to see if they are equivalent. Two labels are equivalent if they have the same style, starting number (the numeric value of the first page associated with the label), and prefix strings which are the same byte-for-byte.
-
- -

Related Methods

- - -
-
- -

Syntax

- -ASBool PDPageLabelEqual(PDPageLabel pdlOne, PDPageLabel pdlTwo); - -

Parameters

- - -
pdlOne
-
A page label.
-
pdlTwo
-
Another page label.
-
- -

Returns

- -
true if the two labels are valid and equivalent, false otherwise.
-
-

PDPageLabelFromCosObj

- -
Header: PDProcs.h:7182
-
- -

Description

- -
Creates a type cast of the CosObj to a PDPageLabel object.
-
- -

Related Methods

- - -
-
- -

Syntax

- -PDPageLabel PDPageLabelFromCosObj(CosObj cosLabel); - -

Parameters

- -
cosLabel
-
IN/OUT The Cos object level representation of a page label.
-
- -

Returns

- -
The page label representation of cosLabel.
- -

Exceptions

- -
-
is raised if cosLabel is not a valid page label.
-
-
-
-

PDPageLabelGetCosObj

- -
Header: PDProcs.h:7168
-
- -

Description

- -
Creates a type cast of the page label object to a Cos object.
-
- -

Related Methods

- - -
-
- -

Syntax

- -CosObj PDPageLabelGetCosObj(PDPageLabel pdl); - -

Parameters

- -
pdl
-
IN/OUT A PDPageLabel representation of a page label.
-
- -

Returns

- -
A CosObj representation of pdl if the page label is valid, NULL CosObj otherwise.
-
-

PDPageLabelGetPrefix

- -
Header: PDProcs.h:7212
-
- -

Description

- -
Returns the prefix string for the label. The prefix string is transitory and should be copied immediately.
-
- -

Related Methods

- -PDPageLabelGetStart -PDPageLabelGetStyle
-
- -

Syntax

- -const char *PDPageLabelGetPrefix(PDPageLabel pgLabel, ASInt32 *prefixLen); - -

Parameters

- - -
pgLabel
-
The label for the page whose prefix is desired.
-
prefixLen
-
(Filled by the method) The length, in bytes, of the prefix string. It is zero if the page label is not valid.
-
- -

Returns

- -
The prefix string for the label, or NULL if none is specified.
-
-

PDPageLabelGetPrefixASText

- -
Header: PDProcs.h:11838
-
- -

Description

- -
Returns the prefix string for the label as an ASText object. The prefix string is transitory and should be copied immediately.
-
- -

Related Methods

- -PDPageLabelGetPrefix -PDPageLabelGetStart -PDPageLabelGetStyle
-
- -

Syntax

- -void PDPageLabelGetPrefixASText(PDPageLabel pgLabel, ASText prefix); - -

Parameters

- - -
pgLabel
-
The label for the page whose prefix is desired.
-
prefix
-
(Filled by the method) The text object containing the prefix string. The client must pass a valid ASText object title. The routine does not allocate it.
-
-
-

PDPageLabelGetStart

- -
Header: PDProcs.h:7225
-
- -

Description

- -
Gets the starting number of a given page label.
-
- -

Related Methods

- -PDPageLabelGetPrefix -PDPageLabelGetStyle
-
- -

Syntax

- -ASInt32 PDPageLabelGetStart(PDPageLabel pgLabel); - -

Parameters

- -
pgLabel
-
The page label for the page whose starting number is desired.
-
- -

Returns

- -
The starting number of the page label; that is, the numeric value of the first page associated with the label. It returns 1 if the page label is not valid or unknown.
-
-

PDPageLabelGetStyle

- -
Header: PDProcs.h:7197
-
- -

Description

- -

Returns an ASAtom for the style of the label.
-

It raises an exception if storage is exhausted or file access fails.

-
-
- -

Related Methods

- -PDPageLabelGetPrefix -PDPageLabelGetStart
-
- -

Syntax

- -ASAtom PDPageLabelGetStyle(PDPageLabel pgLabel); - -

Parameters

- -
pgLabel
-
IN/OUT The page label whose style is desired.
-
- -

Returns

- -
An ASAtom for the label style. If no style is specified, it returns ASAtomFromString(" None").
-
-

PDPageLabelIsValid

- -
Header: PDProcs.h:7140
-
- -

Description

- -

Determines whether a page label is valid.
-

A page label is valid if its values correspond to the specification for page label dictionaries. See the description of Page labels in the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 12.4.2, page 374.

- -

-

You can find this document on the web store of the International Standards Organization (ISO).
-

It raises an exception if storage is exhausted or file access fails.

-
-
- -

Related Methods

- - -
-
- -

Syntax

- -ASBool PDPageLabelIsValid(PDPageLabel pgLabel); - -

Parameters

- -
pgLabel
-
The page label whose validity is determined.
-
- -

Returns

- -
true if the label is valid, false otherwise.
-
-

PDPageLabelNew

- -
Header: PDProcs.h:7285
-
- -

Description

- -
Constructs a new label object in the document with the specified style, prefix, and starting page number.
-
- -

Related Methods

- -PDDocFindPageNumForLabel -PDDocGetLabelForPageNum -PDDocGetPageLabel -PDDocRemovePageLabel -PDDocSetPageLabel
-
- -

Syntax

- -PDPageLabel PDPageLabelNew(PDDoc pdDoc, ASAtom style, const char *prefix, ASInt32 prefixLen, ASInt32 startAt); - -

Parameters

- - - - - -
pdDoc
-
The document that contains the new page label.
-
style
-
The numbering system to use for the numeric portion of each label in this range of pages. The possible values are D for decimal numbers, R for upper-case Roman numbers, r for lower-case Roman numbers, A for upper-case alphabetic numbers, or a for lower-case alphabetic numbers. If it is None, the labels for this range will not have a numeric portion. None is specified by providing ASAtomFromString("None") as the style parameter.
-
prefix
-
A string to prefix to the numeric portion of the page label. It may be a NULL string.
-
prefixLen
-
The length in bytes of the prefix string.
-
startAt
-
The value to use when generating the numeric portion of the first label in this range; it must be greater than or equal to 1.
-
- -

Returns

- -
The newly created page label.
- -

Exceptions

- -
-
is raised if the base pages object is missing or invalid.
-
-
-
-

PDPageLabelNewASText

- -
Header: PDProcs.h:11823
-
- -

Description

- -
Constructs a new label object in the document with the specified style, prefix, and starting page number.
-
- -

Related Methods

- -PDDocFindPageNumForLabel -PDDocGetLabelForPageNum -PDDocGetPageLabel -PDDocRemovePageLabel -PDDocSetPageLabel -PDPageLabelNew
-
- -

Syntax

- -PDPageLabel PDPageLabelNewASText(PDDoc pdDoc, ASAtom style, const ASText prefix, ASInt32 startAt); - -

Parameters

- - - - -
pdDoc
-
The document that contains the new page label.
-
style
-
The numbering system to use for the numeric portion of each label in this range of pages. The possible values are:
- - - - - - -
Value
-
Description
-
D
-
Decimal numbers.
-
R
-
Upper-case Roman numbers.
-
r
-
Lower-case Roman numbers.
-
A
-
Upper-case alphabetic numbers.
-
a
-
Lower-case alphabetic numbers.
-
- -

-

If it is None, the labels for this range will not have a numeric portion. None is specified by providing ASAtomFromString("None") as the style parameter.

-
-
prefix
-
The text object containing the string to prefix to the numeric portion of the page label.
-
startAt
-
The value to use when generating the numeric portion of the first label in this range; it must be greater than or equal to 1.
-
- -

Returns

- -
The newly created page label.
- -

Exceptions

- -
-
is raised if the base pages object is missing or invalid.
-
-
-
-
- -
- - - \ No newline at end of file diff --git a/apdfl18/CPlusPlus/APDFL18.0.4PlusP2y/pdlayer_PDWordFinder.html b/apdfl18/CPlusPlus/APDFL18.0.4PlusP2y/pdlayer_PDWordFinder.html deleted file mode 100644 index 879a7113..00000000 --- a/apdfl18/CPlusPlus/APDFL18.0.4PlusP2y/pdlayer_PDWordFinder.html +++ /dev/null @@ -1,520 +0,0 @@ - - - - - - - - -PD Layer: PDWordFinder - - - - -
-DL Logo -
-
-
-
-
-

PDWordFinder Definitions

- -

WF_LATEST_VERSION

- -
Header: PDExpT.h:3639
-
- -

Description

- -
Used to obtain the latest available version.
-
- -

Syntax

- -#define WF_LATEST_VERSION 0 -
-

WF_VERSION_2

- -
Header: PDExpT.h:3643
-
- -

Description

- -
The version used for Acrobat 3.x, 4.x.
-
- -

Syntax

- -#define WF_VERSION_2 2 -
-

WF_VERSION_3

- -
Header: PDExpT.h:3647
-
- -

Description

- -
For Acrobat 5.0 without accessibility enabled.
-
- -

Syntax

- -#define WF_VERSION_3 3 -
-

WF_VERSION_4

- -
Header: PDExpT.h:3651
-
- -

Description

- -
For Acrobat 5.0 with accessibility enabled.
-
- -

Syntax

- -#define WF_VERSION_4 4 -
-
-
-

PDWordFinder Functions

- -

PDWordFinderAcquireVisibleWordList

- -
Header: PDProcs.h:10683
-
- -

Description

- -

Finds all words on the specified page that are visible in the given optional-content context and returns one or more tables containing the words. One table contains the words sorted in the order in which they appear in the PDF file, while the other contains the words sorted by their x- and y-coordinates on the page.
-

The list contains only words that are visible in the given context. If the word states change in the given context, the word list will have to be released and re-acquired to reflect the changed set of visible words.

- -

-

There can be only one word list in existence at a time; clients must release the previous word list, using PDWordFinderReleaseWordList(), before creating a new one.

- -

-

Use PDWordFinderEnumWords() instead of this method if you wish to find one word at a time instead of obtaining a table containing all visible words on a page.

- -

-

This procedure is intended to replace the call to PDWordFinderAcquireWordList() in most cases where you want to work only with the content that is visible on screen (such as a text selection). Change this call to update an application to work with the Optional Content feature.

-
-
- -

Related Methods

- -PDDocCreateWordFinder -PDDocCreateWordFinderUCS -PDWordFinderAcquireWordList -PDWordFinderEnumWords -PDWordFinderGetNthWord -PDWordFinderReleaseWordList
-
- -

Syntax

- -void PDWordFinderAcquireVisibleWordList(PDWordFinder wObj, ASInt32 pgNum, PDOCContext ocContext, PDWord *wInfoP, PDWord **xySortTable, PDWord **rdOrderTable, ASInt32 *numWords); - -

Parameters

- - - - - - - -
wObj
-
The word finder (created using PDDocCreateWordFinder() or PDDocCreateWordFinderUCS()) used to acquire the word list.
-
pgNum
-
The page number for which words are found. First page is 0, not 1 as designated in Acrobat.
-
ocContext
-
The context within which the words are in a visible state. NULL is equivalent to passing PDDocGetOCContext(pdDoc).
-
wInfoP
-

(Filled by the method) A user-supplied PDWord variable. Acrobat will fill this in to point to an Acrobat-allocated array of PDWord objects, which should never be accessed directly.
-

Access the acquired list through PDWordFinderGetNthWord(). The words are ordered in PDF order, which is the order in which they appear in the PDF file's data. This is often, but not always, the order in which a person would read the words. Use PDWordFinderGetNthWord to traverse this array; you cannot access this array directly. This array is always filled, regardless of the flags used in the call to PDDocCreateWordFinder() or PDDocCreateWordFinderUCS().

-
-
xySortTable
-
(Filled by the method) Acrobat fills in this user-supplied pointer to a pointer with the location of an Acrobat-allocated array of PDWords, sorted in x-y order, meaning that all words on the first line, from left to right, followed by all words on the next line. This array is only filled if the WXE_XY_SORT flag was set in the call to PDDocCreateWordFinder() or PDDocCreateWordFinderUCS(). PDWordFinderReleaseWordList() must be called to release allocated memory for this return or there will be a memory leak. As long as this parameter is non- NULL, the array is always filled regardless of the value of the rdFlags parameter in PDDocCreateWordFinder().
-
rdOrderTable
-
Currently unused. Pass NULL for its value.
-
numWords
-
(Filled by the method) The number of visible words found on the page.
-
- -

Exceptions

- -
-
-
-
-
-

PDWordFinderAcquireWordList

- -
Header: PDProcs.h:4778
-
- -

Description

- -

Finds all words on the specified page and returns one or more tables containing the words. One table contains the words sorted in the order in which they appear in the PDF file, while the other contains the words sorted by their x- and y-coordinates on the page.
-

Only words within or partially within the page's crop box (see PDPageGetCropBox()) are enumerated. Words outside the crop box are skipped.

- -

-

There can be only one word list in existence at a time; clients must release the previous word list, using PDWordFinderReleaseWordList(), before creating a new one.

- -

-

Use PDWordFinderEnumWords() instead of this method, if you wish to find one word at a time instead of obtaining a table containing all words on a page.

-
-
- -

Related Methods

- -PDDocCreateWordFinder -PDDocCreateWordFinderUCS -PDWordFinderEnumWords -PDWordFinderGetNthWord -PDWordFinderReleaseWordList
-
- -

Syntax

- -void PDWordFinderAcquireWordList(PDWordFinder wObj, ASInt32 pgNum, PDWord *wInfoP, PDWord **xySortTable, PDWord **rdOrderTable, ASInt32 *numWords); - -

Parameters

- - - - - - -
wObj
-
The word finder (created using PDDocCreateWordFinder() or PDDocCreateWordFinderUCS()) used to acquire the word list.
-
pgNum
-
The page number for which words are found. The first page is 0, not 1 as designated in Acrobat.
-
wInfoP
-

(Filled by the method) A user-supplied PDWord variable. Acrobat will fill this in to point to an Acrobat-allocated array of PDWord objects, which should never be accessed directly.
-

Access the acquired list through PDWordFinderGetNthWord(). The words are ordered in PDF order, which is the order in which they appear in the PDF file's data. This is often, but not always, the order in which a person would read the words. Use PDWordFinderGetNthWord() to traverse this array; you cannot access this array directly. This array is always filled, regardless of the flags used in the call to PDDocCreateWordFinder() or PDDocCreateWordFinderUCS().

-
-
xySortTable
-
(Filled by the method) Acrobat fills in this user-supplied pointer to a pointer with the location of an Acrobat-allocated array of PDWords, sorted in x-y order, meaning that all words on the first line, from left to right, are followed by all words on the next line. This array is only filled if the WXE_XY_SORT flag was set in the call to PDDocCreateWordFinder() or PDDocCreateWordFinderUCS(). PDWordFinderReleaseWordList() must be called to release allocated memory for this return or there will be a memory leak. As long as this parameter is non- NULL, the array is always filled regardless of the value of the rdFlags parameter in PDDocCreateWordFinder().
-
rdOrderTable
-
Currently unused. Pass NULL for this value.
-
numWords
-
(Filled by the method) The number of words found on the page.
-
- -

Exceptions

- -
-
-
-
-
-

PDWordFinderDestroy

- -
Header: PDProcs.h:4826
-
- -

Description

- -
Destroys a word finder. Use this when you are done extracting text in a file.
-
- -

Related Methods

- -PDDocCreateWordFinder -PDDocCreateWordFinderUCS -PDDocGetWordFinder
-
- -

Syntax

- -void PDWordFinderDestroy(PDWordFinder wObj); - -

Parameters

- -
wObj
-
IN/OUT The word finder to destroy.
-
-
-

PDWordFinderEnumVisibleWords

- -
Header: PDProcs.h:10757
-
- -

Description

- -

Extracts visible words, one at a time, from the specified page or the entire document. It calls a user-supplied procedure once for each word found. If you wish to extract all text from a page at once, use PDWordFinderAcquireWordList() instead of this method.
-

Only words that are visible in the given optional-content context are enumerated.

-
-
- -

Related Methods

- -PDDocCreateWordFinder -PDDocCreateWordFinderUCS -PDDocGetWordFinder -PDWordFinderAcquireWordList -PDWordFinderEnumWords -PDWordFinderEnumWordsStr
-
- -

Syntax

- -ASBool PDWordFinderEnumVisibleWords(PDWordFinder wObj, ASInt32 PageNum, PDOCContext ocContext, PDWordProc wordProc, void *clientData); - -

Parameters

- - - - - -
wObj
-
A word finder object.
-
PageNum
-
The page number from which to extract words. Pass PDAllPages (see PDExpT.h) to sequentially process all pages in the document.
-
ocContext
-
The context within which the words are in a visible state. NULL is equivalent to passing PDDocGetOCContext(pdDoc).
-
wordProc
-
A user-supplied callback to call once for each word found. Enumeration halts if wordProc returns false.
-
clientData
-
A pointer to user-supplied data to pass to wordProc each time it is called.
-
- -

Returns

- -
true if enumeration was successfully completed, false if enumeration was terminated because wordProc returned false.
- -

Exceptions

- -
-
-
is raised if wordProc is NULL, or pageNum is less than zero or greater than the total number of pages in the document.
-
-
-
-
-
-

PDWordFinderEnumWords

- -
Header: PDProcs.h:4862
-
- -

Description

- -

Extracts words, one at a time, from the specified page or the entire document. It calls a user-supplied procedure once for each word found. If you wish to extract all text from a page at once, use PDWordFinderAcquireWordList() instead of this method.
-

Only words within or partially within the page's crop box (see PDPageGetCropBox()) are enumerated. Words outside the crop box are skipped.

-
-
- -

Related Methods

- -PDDocCreateWordFinder -PDDocCreateWordFinderUCS -PDDocGetWordFinder -PDWordFinderAcquireWordList -PDWordFinderEnumVisibleWords -PDWordFinderEnumWordsStr
-
- -

Syntax

- -ASBool PDWordFinderEnumWords(PDWordFinder wObj, ASInt32 PageNum, PDWordProc wordProc, void *clientData); - -

Parameters

- - - - -
wObj
-
A word finder object.
-
PageNum
-
The page number from which to extract words. Pass PDAllPages (see PDExpT.h) to sequentially process all pages in the document.
-
wordProc
-
A user-supplied callback to call once for each word found. Enumeration halts if wordProc returns false.
-
clientData
-
A pointer to user-supplied data to pass to wordProc each time it is called.
-
- -

Returns

- -
true if enumeration was successfully completed, false if enumeration was terminated because wordProc returned false.
- -

Exceptions

- -
-
-
is raised if wordProc is NULL, or pageNum is less than zero or greater than the total number of pages in the document.
-
-
-
-
-
-

PDWordFinderEnumWordsStr

- -
Header: PDProcs.h:8719
-
- -

Description

- -

Constructs a PDWord list from a Unicode string, and calls a user-supplied procedure once for each word found.
-

The words extracted by this method do not have quads, text style, or text selection information. The character offset is calculated from the beginning of the input string, and is increased by 2 on every 16 bits of data (the character offset of a character in a PDWord is the byte offset of the character in the source Unicode string).

-
-
- -

Related Methods

- -PDDocCreateWordFinder -PDDocCreateWordFinderUCS -PDDocGetWordFinder -PDWordFinderAcquireWordList -PDWordFinderEnumVisibleWords -PDWordFinderEnumWords
-
- -

Syntax

- -ASBool PDWordFinderEnumWordsStr(PDWordFinder wObj, const ASUTF16Val *ucsStr, ASUns32 strLen, ASUns32 charOffsetAdj, PDWordProc wordProc, void *clientData); - -

Parameters

- - - - - - -
wObj
-
A word finder object.
-
ucsStr
-
A pointer to the Unicode string.
-
strLen
-
The length of the string in bytes.
-
charOffsetAdj
-

The character offset value of the first character in the input Unicode string. This value is added to the word character offsets, and is used to maintain contiguous word character offsets when multiple strings (and multiple calls to this method) are combined into one word list.
-

For example:

- -

-

PDWordFinderEnumWordsStr(wf, str1, stelen(str1), 0, wp, d);

- -

-

PDWordFinderEnumWordsStr(wf, str2, stelen(str2), stelen(str1), wp, d);

-
-
wordProc
-
A user-supplied callback to call once for each word found. Enumeration halts if wordProc returns false.
-
clientData
-
A pointer to user-supplied data to pass to wordProc each time it is called.
-
- -

Returns

- -
true if the enumeration was successfully completed, false if the enumeration was terminated because wordProc returned false.
- -

Exceptions

- -
-
-
is raised if wordProc is NULL.
-
-
-
-
-
-

PDWordFinderGetLatestAlgVersion

- -
Header: PDProcs.h:4797
-
- -

Description

- -
Gets the version number of the specified word finder, or the version number of the latest word finder algorithm.
-
- -

Related Methods

- -PDDocCreateWordFinder -PDDocCreateWordFinderUCS -PDDocGetWordFinder
-
- -

Syntax

- -ASInt16 PDWordFinderGetLatestAlgVersion(PDWordFinder wObj); - -

Parameters

- -
wObj
-
IN/OUT The word finder whose algorithm's version is obtained. Pass NULL to obtain the latest word finding algorithm version number.
-
- -

Returns

- -
The algorithm version associated with wObj, or the version of the latest word finder algorithm if wObj is NULL.
-
-

PDWordFinderReleaseWordList

- -
Header: PDProcs.h:4814
-
- -

Description

- -
Releases the word list for a given page. Use this to release a list created by PDWordFinderAcquireWordList() when you are done using this list.
-
- -

Related Methods

- -PDDocCreateWordFinder -PDDocCreateWordFinderUCS -PDDocGetWordFinder -PDWordFinderAcquireWordList
-
- -

Syntax

- -void PDWordFinderReleaseWordList(PDWordFinder wObj, ASInt32 pgNum); - -

Parameters

- - -
wObj
-
A word finder object.
-
pgNum
-
The number of pages for which a word list is released.
-
- -

Exceptions

- -
-
is raised if the list has already been released.
-
-
-
-
- -
- - - \ No newline at end of file diff --git a/apdfl18/CPlusPlus/APDFL18.0.4PlusP2y/pdslayer_PDSMCRef.html b/apdfl18/CPlusPlus/APDFL18.0.4PlusP2y/pdslayer_PDSMCRef.html deleted file mode 100644 index ace21247..00000000 --- a/apdfl18/CPlusPlus/APDFL18.0.4PlusP2y/pdslayer_PDSMCRef.html +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - - -PDSEdit Layer: PDSMCRef - - - - -
-DL Logo -
-
-
-
-
-

PDSMCRef Typedefs

- -

PDSMCRef

- -
Header: PDSExpT.h:147
-
- -

Syntax

- -typedef PDSMCRefRec *PDSMCRef; -
-

PDSMCRef

- -
Header: PDSExpT.h:151
-
- -

Syntax

- -typedef struct _t_PDSMCRef *PDSMCRef; - -

Returned From

- - - -

Used By

- - -
-
-
-

PDSMCRef Functions

- -

PDSMCRefDestroy

- -
Header: PDSWriteProcs.h:888
-
- -

Description

- -
Destroys a marked content reference created with PDSMCRefCreate(). This should only be called once the reference has been placed in the structure tree or if the reference is no longer needed.
- -

Note: If the PDSMCRef is associated with a PDSMC, it will be set as invalid and ignored on subsequent processing.

-
- -

Related Methods

- -PDSElementInsertMCRefAsKid -PDSMCRefCreate
-
- -

Syntax

- -void PDSMCRefDestroy(IN PDSMCRef ref); - -

Parameters

- -
ref
-
The marked content reference to destroy.
-
- -

Exceptions

- -
Unknown
-
-
-
-
-
- -
- - - \ No newline at end of file diff --git a/apdfl18/CPlusPlus/APDFL18.0.4PlusP2y/TOC.html b/apdfl18/CPlusPlus/APDFL18.0.5PlusP1c/TOC.html similarity index 99% rename from apdfl18/CPlusPlus/APDFL18.0.4PlusP2y/TOC.html rename to apdfl18/CPlusPlus/APDFL18.0.5PlusP1c/TOC.html index 7e200462..71c1f814 100644 --- a/apdfl18/CPlusPlus/APDFL18.0.4PlusP2y/TOC.html +++ b/apdfl18/CPlusPlus/APDFL18.0.5PlusP1c/TOC.html @@ -1235,7 +1235,6 @@
  • marksStyles