Verifies the existence and returns the value of a parameter field or structure.
DWORD dispCheckParmByName (CTAHD ctahd, char *parmname, void *buffer, unsigned size)
|
Argument |
Description |
|
ctahd |
Context handle. |
|
parmname |
Pointer to the parameter name or field. |
|
buffer |
Pointer to a buffer to receive the parameter value. |
|
size |
Size of the memory area. |
|
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 |
The specified ctahd is invalid. |
|
CTAERR_NOT_FOUND |
The specified parameter does not exist or the owning service was not initialized. |
|
CTAERR_NOT_IMPLEMENTED |
Function was called from the service interface. |
|
CTAERR_NOT_INITIALIZED |
Natural Access was not initialized. |
|
CTAERR_SVR_COMM |
Natural Access Server is not running. |
dispCheckParmByName verifies the existence and returns the value of a parameter field or structure. This function is the same as dispGetParmByName except that it does not log an error if one occurs. The service is indicated as the first part of the parameter name string, for example, ADI in adi.play.gain.