Table of Contents

NMS Glossary

Previous Page

Next Page

(Page 3 of 36 in this chapter) Version

dispCheckParmByName

Description

Verifies the existence and returns the value of a parameter field or structure.

Prototype

DWORD dispCheckParmByName ( CTAHD ctahd,
char *parmname,
void *buffer,
unsigned size)
ctahd Context handle.
parmname Pointer to the parameter name or field.
buffer Pointer to buffer to receive parameter value.
size Size of memory area.

Return Values

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.

Events

None.

Details

This function 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.

See Also

dispGetParmByName, dispGetParms

Table of Contents

NMS Glossary

Previous Page

Next Page

(Page 3 of 36 in this chapter) Version

Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com

Copyright © 2001, Natural MicroSystems, Inc. All rights reserved.