GetWebCaptureCommand

Document structure

Description

Reads one ISO Web Capture command dictionary from the selected document's catalog /SpiderInfo /C array

Syntax

Delphi

Function GetWebCaptureCommand(Index: Integer; Out Command: TPDFlibWebCaptureCommand): Integer;

Return values

0No valid command was read
1Command contains the requested metadata

Failure behavior

Returns 0 when Index is outside the 1-based command range, the indexed object is not a command dictionary or its required /URL string is missing or empty. On failure, Command is reset to an empty URL, Levels 1, Flags 0 and empty optional strings

Remarks

Index is 1-based. Missing /L and /F entries retain the defaults 1 and 0. PostData accepts either a PDF string or a decoded PDF stream, while URL, ContentType and Headers are read from PDF strings. This API only reads ISO Web Capture command metadata and does not fetch or crawl the recorded URL

See also

TPDFlibWebCaptureCommand, GetWebCaptureCommandCount, AddWebCaptureCommand, ClearWebCaptureCommands