# dispGetParms

Returns parameter values for a specified parameter structure.

#### Prototype

DWORD dispGetParms (CTAHD ctahd, unsigned parmid, void *buffer, unsigned size)

Argument | Description
ctahd | Context handle.
parmid | Pointer to the parameter identifier.
buffer | Pointer to a 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 | size is too small to receive the data structure.
CTAERR_INVALID_CTAHD | Specified ctahd is invalid.
CTAERR_NOT_FOUND | Specified parameter does not exist or the 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

dispGetParms retrieves the parameter values for the entire parameter structure identified by the parmid.

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.

size specifies the amount of available memory at buffer and must be large enough to contain the returned parameter structure.

#### See also

dispCheckParmByName, dispGetParmByName, dispSetParmByName