GetAnnotSoundToFile

Annotations and hotspot links

Description

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

Syntax

Delphi

function TPDFlib.GetAnnotSoundToFile(Index, Options: Integer; Const SoundFileName: WideString): Integer;

ActiveX

Function PDFlib::GetAnnotSoundToFile(Index As Long, Options As Long, SoundFileName As String) As Long

DLL

int DLGetAnnotSoundToFile(int InstanceID, int Index, int Options, wchar_t * 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