CopyExportedWavToMemory method

CopyExportedWavToMemory method

Remarks

After calling the RequestSoundExportToWav method, in order to export the loaded song into a WAV file stored in memory, and receiving a successful ExportToWavStop event, this method allows copying into a memory buffer, allocated by the container application, the full contents of the memory WAV file: after this call the original memory buffer is immediately discarded from memory.

For further details about exporting a sound to a file in WAV format take a look to the How to export the loaded song into a WAV file section.

Syntax

[Visual Basic]

Public Function CopyExportedWavToMemory (

nPlayerIndex as Int16,

pBuffer() as Byte,

nBufferLength as Int32

) as enumErrorCodes

[C#]

public enumErrorCodes CopyExportedWavToMemory (

Int16 nPlayerIndex,

byte[] pBuffer,

Int32 nBufferLength

);

[C++]

public: enumErrorCodes CopyExportedWavToMemory (

Int16 nPlayerIndex,

unsigned char __gc[] pBuffer,

Int32 nBufferLength

);

Parameter	Description

nPlayerIndex	Number representing the zero-based index of the involved player
pBuffer	Buffer where WAV memory file contents will be copied
nBufferLen	Length in bytes of the given buffer

Return value

Value	Meaning

Negative value	An error occurred (see the LastError property for further error details)
enumErrorCodes.NOERROR (0)	The method call was successful.

Return to Table of contents