Retrieves a function parameter field or structure for a given parameter name.

DWORD adiGetParmByName( char *parmname,
void *buffer,
unsigned size )

parmname Pointer to string containing the parameter name to retrieve.

buffer Buffer that receives the current value for the specified parameter.

size Size of buffer (the size must be large enough to store the parameters being retrieved).

• SUCCESS
• CTAERR_BAD_SIZE
  size is less than the parameter size.
• CTAERR_BAD_ARGUMENT
  NULL values for parmname or buffer.
• CTAERR_NOT_FOUND
  parmname not found.

None.

This function retrieves the current value for the parameter identified as parmname. AG Access writes the value to the address specified in buffer. The size argument specifies how much memory is available at the address and must be large enough to contain the returned parameter value.

The parmname format is structname or structname[.fieldname]. If the field name is omitted, the complete current parameter structure is returned.

This function is intended primarily for utility applications; e.g., displaying the current value of a parameter based on its name.

In general, it is more efficient to use adiGetParms to get default parameters.

adiGetParms, adiGetParmInfo, adiConfigParm

void myShowPlayGain()
{
    INT32 playgain;

    adiGetParmByName( "adiplay.gain", &playgain, sizeof playgain );
    printf( "Default adiplay.gain is %d dB\n", playgain );
}