GetAnnotSoundToFileA

Annotations and hotspot links

Description

The trailing A denotes the ANSI (char) DLL entry point; the ActiveX/COM surface exposes only the Unicode form. Behaviour is identical to GetAnnotSoundToFile and string arguments are interpreted using the current SetAnsiMode code page

Copies the sound data stored in the specified annotation into a file.

Syntax

Delphi

Function DLGetAnnotSoundToFileA(InstanceID, Index, Options: Integer; SoundFileName: PAnsiChar): Integer;

DLL

int DLGetAnnotSoundToFileA(int InstanceID, int Index, int Options, const char * SoundFileName);

Parameters

IndexThe index of the annotation. The first annotation on the page has an index of 1.
Options0 = Sound data as stored in the PDF 1 = Encode data as a WAV file
SoundFileNameThe path and name of the file to create containing the sound data.

Return values

0The sound could not be written
1The sound was written successfully