##### [API function]

## FSOUND_Stream_GetTagField

Get a tag field associated with an open stream.

signed char F_API FSOUND_Stream_GetTagField(
FSOUND_STREAM *stream,
int num,
int *type,
char **name,
void **value,
int *length
);

### Parameters

stream | The stream to get the tag field from.
num | The number of the tag field to retrieve.
type | Pointer to a variable that will receive the type of the tag field that was retrieved. See FSOUND_TAGFIELD_TYPE.
name | Pointer to a variable that will receive the name of the tag field as a null-terminated ASCII string.
value | Pointer to a variable that will receive a pointer to the tag field data.
length | Pointer to a variable that will receive the length of the tag field data.

### Return Value

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

### Remarks

Do not attempt to modify or free any pointers returned by this function.
If this function returns successfully, "value" will contain a pointer to a piece of tag-field-specific data - do not assume it will always point to a null-terminated ASCII string.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh

### See Also

FSOUND_Stream_FindTagField , FSOUND_Stream_GetNumTagFields , FSOUND_TAGFIELD_TYPE

This document copyright ©Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.
Generated Thu Dec 15 17:31:36 2005 by SourceDoc v0.10, the automated source code documenter.