# dispGetParmByName

Retrieves the value of a parameter field or structure specified by name.

#### Prototype

DWORD dispGetParmByName (CTAHD ctahd, char *parmname, void *buffer, unsigned size)

Argument | Description
ctahd | Handle to a Natural Access context.
parmname | Pointer to a parameter name or field.
buffer | Pointer to buffer to receive the parameter value.
size | Size of the memory area.

#### Return values

Return value | Description
SUCCESS |
CTAERR_BAD_ARGUMENT | Required pointer argument is NULL.
CTAERR_BAD_SIZE | buffer is too small to receive the data structure.
CTAERR_INVALID_CTAHD | Specified ctahd is invalid.
CTAERR_NOT_FOUND | Specified parameter does not exist or owning service is not initialized.
CTAERR_NOT_IMPLEMENTED | Function was called from the service interface.
CTAERR_NOT_INITIALIZED | Natural Access is not initialized.
CTAERR_SVR_COMM | Natural Access Server is not running.

#### Details

dispGetParmByName retrieves the value for the parameter identified as parmname.

ctahd must refer to a valid context since this function only retrieves the parameters from the context defaults. Services cannot retrieve or modify global defaults.

Natural Access writes the values to buffer. The size argument specifies the amount of available memory at buffer and must be large enough to contain the returned parameter value.

The parmname format is svcname[.x].structname[.fieldname]. The service name and parameter structure name must be supplied. The extension specifier and field name are optional. If the parameter or parameter structure are extensions to the standard service parameters, the literal text .x must be included in parmname. If the field name is omitted, the complete default parameter structure is returned.

An example of parmname is vce.play.gain.

#### See also

dispCheckParmByName, dispGetParms, dispSetParmByName