AUpvnew(3dm)

NAME
     AUpvlist, AUpvnew, AUpvfree, AUpvgetmaxitems, AUpvsetvaltype,
     AUpvsetparam, AUpvsetval, AUpvgetvaltype, AUpvgetparam, AUpvgetval -
     Audio File parameter value list data type


SYNOPSIS
     #include <dmedia/dm_audioutil.h>
     -ldmedia

     AUpvlist AUpvnew(int numitems)
     int AUpvfree(AUpvlist pvlist)
     int AUpvgetmaxitems(AUpvlist pvlist)
     int AUpvsetvaltype(AUpvlist pvlist, int item, int type)
     int AUpvsetparam(AUpvlist pvlist, int item, int param)
     int AUpvsetval(AUpvlist pvlist, int item, void *val_ptr)
     int AUpvgetvaltype(AUpvlist pvlist, int item, int *type_ptr)
     int AUpvgetparam(AUpvlist pvlist, int item, int *param_ptr)
     int AUpvgetval(AUpvlist pvlist, int item, void *val_ptr)



PARAMETERS
          pvlist_ptr  Pointer to an Audio File Library parameter/value list
                      data type.


          pvlist      An Audio File Library parameter value list data type as
                      created by AUpvnew.


          numitems    an integer representing the size to create a new
                      AUpvlist.


          item        a integer zero based index into an AUpvlist. The index
                      should be non-negative and less than numitems-1.


          type        a symbolic constant describing the type a parameter.
                      Currently supported types are:

                      AU_PVTYPE_LONG
                           representing values which are long

                      AU_PVTYPE_DOUBLE
                           representing values which are double precision
                           floating point
          param       is an integer which will become the parameter or the
                      parameter/value pair.



          val         is a pointer to a void type.  Data will be read from
                      this pointer, interpreted according to the type
                      associated with this entry, and stored in the AUpvlist.



          param_ptr   is a pointer to an integer which is filled with the
                      value of the parameter portion of a parameter/value
                      pair.


          value_ptr   is a pointer to a void type.  Data representing the
                      value portion of a parameter/value pair is copied to
                      this address as interpreted by this entry's type.



DESCRIPTION
          AUpvnew
               creates a new empty AUpvlist of size numitems. All entries
               default to type AU_PVTYPE_LONG. All parameters and values are
               initialized to zero.  The memory pointed to by argument
               pvlist_ptr is set to the new list.


          AUpvfree
               Destroys dynamic memory associated with an initialized
               AUpvlist, making it futile for use in future calls.


          AUpvgetmaxitems
               Returns the number of list entries which were allocated for
               pvlist when it was created by AUpvnew.


          AUpvsetvaltype
               Sets the type of the value of the item-th entry in pvlist to
               type.


          AUpvgetvaltype
               Finds the value's type of the item-th entry in pvlist and
               returns it in type_ptr.
          AUpvsetval
               Set the value of the item-th entry in pvlist to the value
               stored in val_ptr.


          AUpvgetval
               Returns the value of the item-th entry in pvlist in val_ptr.


          AUpvsetparam
               Sets the parameter of the item-th entry in pvlist to param.


          AUgetparam
               Gets the parameter of the item-th entry in pvlist and returns
               it in param_ptr.



RETURN VALUE
     On successful completion, AUpvnew returns a valid opaque AUpvlist data
     structure. If numitems <= 0 or there is a memory allocation error,
     AUpvnew returns a null pointer (AU_NULL_PVLIST).


     On successful completion, all other functions return a non-negative
     value.