AuGetElements (3)

Leading comments

$NCDId: @(#)AuGetEl.man,v 1.1 1994/09/27 00:29:24 greg Exp $
copyright 1994 Steven King

portions are
* Copyright 1993 Network Computing Devices, Inc.
*
* Permission to use, copy, modify, distribute, and sell this software and its
* documentation for any purpose is hereby granted without fee, provided that
* the above copyright notice appear in all copies and that both that
* copyright notice and this permission notice appear in supporting
* documentation, and that the name Network Computing ...

(The comments found at the beginning of the groff file "man3/AuGetElements.3nas".)

Name

AuGetElements - get the elements in a flow

Synopsis

#include <audio/audiolib.h>

AuElement *AuGetElements(server, flow, clocked, num_elements, status)

    AuServer *server;

    AuFlowID flow;

    AuBool *clocked; /* RETURN */

    int *num_elements; /* RETURN */

    AuStatus *status; /* RETURN */

Arguments

server

Specifies the connection to the audio server.

flow

Specifies the ID of the flow to get the elements from.

clocked

Returns a boolean value that indicates if the flow is clocked.

num_elements

Returns the number of elements.

status

If non-NULL, flush the output buffer and return the status from the server.

Description

AuGetElements returns the list of elements comprising flow or NULL, with num_elements set to 0, if there was an error. Use AuFreeElements to free this list when nolonger needed.

Errors

AuBadFlow.

See Also

AuSetElements.

audiolib - Network Audio System C Language Interface