Legacy Document

Inside Macintosh: Cyberdog Programmer's Kit / Part 3 - Cyberdog Reference

Chapter 7 - Classes and Methods / ParameterSet

ExtractParameter

Removes the specified parameter from this parameter set without calling the parameter's destructor.

ODBoolean ExtractParameter (in ParameterKey key,
out void* param,
out ParamDestructorUPP destructor);

key

The name of the parameter to remove.

param

A pointer to the parameter.

destructor

A pointer to a programmer-defined destructor for the parameter.

return value

kODTrue if the parameter is in the set; otherwise, kODFalse.

DISCUSSION

You call this method to remove a parameter from a ParameterSet object. Unlike RemoveParameter, this method does not call the destructor associated with the parameter.

The following type is used for parameter destructor functions. A parameter destructor takes two parameters: an environment pointer and a pointer of type void*; the function returns no value.

typedef void (* ParamDestructorProcPtr)(Environment* ev,
void* param);

The MyParamDestructor programmer-defined function (page 194) illustrates the form of a parameter destructor.

SEE ALSO

The ParameterKey type (page 171).
The GetParameter method (page 396).
The PutParameter method (page 397).
The RemoveParameter method (page 398).