AuGetElementStates (3)

Leading comments

$NCDId: @(#)AuGElSt.man,v 1.1 1994/09/27 00:28:44 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/AuGetElementStates.3nas".)

Name

AuGetElementStates - get the state of elements in a flow

Synopsis

#include <audio/audiolib.h>

AuElementState *AuGetElementStates(server, num_states, states, status)

    AuServer *server;

    int *num_states; /* SEND and RETURN */

    AuElementState *states;

    AuStatus *status; /* RETURN */

Arguments

server

Specifies the connection to the audio server.

num_states

Specifies the number of element states in states and returns the number of element states actually returned.

states

Specifies the list of AuElementState structures indicating the flow and element number of the elements to return the state of.

status

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

Description

AuGetElementStates returns a list of element states, or NULL, with num_states set to 0, if there was an error. Use AuFreeElementStates to free this list when nolonger needed.

NOTES

Attempting to get the state of a non-component element (AddConstant, Bundle, ExportMonitor, MultiplyConstant, and Sum) will result in an error.

Errors

AuBadFlow, AuBadLength, AuBadAlloc, AuBadElement.

See Also

AuSetElementStates.

audiolib - Network Audio System C Language Interface