dmParamsGetNumElems(3dm)dmParamsGetNumElems(3dm)NAME
dmParamsGetNumElems, dmParamsGetType, dmParamsIsPresent,
dmParamsCopyElem, dmParamsCopyAllElems, dmParamsRemoveElem - manipulate
the contents of a digital media parameter/value list
SYNOPSIS
#include <dmedia/dm_params.h>
int dmParamsGetNumElems
( const DMparams* params )
DMparamtype dmParamsGetType
( const DMparams* params,
const char* paramName )
DMboolean dmParamsIsPresent
( const DMparams* params,
const char* paramName )
DMstatus dmParamsCopyElem
( const DMparams* fromParams,
const char* paramName,
DMparams* toParams )
DMstatus dmParamsCopyAllElems
( const DMparams* fromParams,
DMparams* toParams )
const char* dmParamsRemoveElem
( const DMparams* params,
const char* paramName )
DESCRIPTIONdmParamsGetNumElems returns the number of elements present in a
parameter/value list. The number of elements in a list, and their
ordering is guaranteed to remain stable unless the list is changed using
one of the "set" functions, by copying an element into it, or by removing
an element.
dmParamsGetType returns the type of value stored in an entry in the list.
The value returned will be one of: DM_TYPE_ENUM, DM_TYPE_INT,
DM_TYPE_STRING, DM_TYPE_FLOAT, DM_TYPE_FRACTION, DM_TYPE_PARAMS, or
DM_TYPE_TOC_ENTRY.
dmParamsIsPresent tests to see if an element with the given name is
present in the list. DM_TRUE is returned if so, DM_FALSE if not.
dmParamsCopyElem copies one parameter/value pair from one list to
another. If there was previously a parameter with the same name in the
destination list, the previous value will be lost. DM_SUCCESS is
returned if there is enough memory to hold the copied element, DM_FAILURE
if not.
Page 1
dmParamsGetNumElems(3dm)dmParamsGetNumElems(3dm)
dmParamsCopyAllElems copies the entire contents of one parameter list to
another. If there are any parameters with the same name in both lists,
the value in the destination list will be lost. DM_SUCCESS is returned
if there is enough memory to hold the copied data, DM_FAILURE if not.
dmParamsRemoveElem removes one element from the given list. The element
named must be present.
NOTES
The indexed routines dmParamsGetElem and dmParamsGetElemType have been
obsoleted. Instead, to determine the type of an element, use
dmParamsGetType. To traverse a parameter/value list, use dmParamsScan.
SEE ALSOdmParams(3dm), dmParamsGetInt(3dm), dmParamsSetInt(3dm),
dmParamsScan(3dm), dmSetImageDefaults(3dm), dmSetAudioDefaults(3dm).
Page 2
