Previous Topic Index Next Topic
[API function]

FSOUND_Sample_Unlock

Releases previous sample data lock from FSOUND_Sample_Lock

signed char F_API FSOUND_Sample_Unlock(
FSOUND_SAMPLE *sptr,
void *ptr1,
void *ptr2,
unsigned int len1,
unsigned int len2
);

Parameters

sptr Pointer to the sample definition.
offset Offset in BYTES to the position you want to lock in the sample buffer.
ptr1 Pointer to the 1st locked portion of sample data, from FSOUND_Sample_Lock.
ptr2 Pointer to the 2nd locked portion of sample data, from FSOUND_Sample_Lock.
len1 Length of data in BYTES that was locked for ptr1
len2 Length of data in BYTES that was locked for ptr2.
This will be 0 if the data locked hasnt wrapped at the end of the buffer.

Return Value

On success, TRUE is returned.
On failure, FALSE is returned.

Remarks

___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox

See Also

FSOUND_Sample_Alloc , FSOUND_Sample_Lock , FSOUND_Sample_Upload

This document copyright ©Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.
Generated Fri Dec 20 16:31:09 2002 by SourceDoc v0.10, the automated source code documenter.