API Guide
601355 Rev A Getting Started 1-13
Getting Started
Each handle has the four base routines descried in the table below: The following example creates a command handle and uses the assignment function to set the priority field within the command object to a value of 10.
Routine Description
initializer The initializer creates and initializes the data
held by the handle and returns a pointer to the
client that is used as a parameter to the
destructor, assignment, and accessor
functions.
destructer The destructor frees the space he ld by the
handle.
assignment The assignment function allows the client to
assign values to fields within the handle. A call
to the assignment function takes a variable
argument list that includes a handle and a list
of identifier-value pairs. The handle identifies
the handle for which field values are being
assigned. An identifier-value pair identifies the
field for which a value is being assigned and
the value being assigned to that field.
accessor The accessor function allows the client to
retrieve values from fields within the handle. A
call to the accessor function takes a variable
argument list that includes a handle and a list
of identifier-pointer pairs. The handle identifies
the handle for which field values are to be
retrieved. An identifier-pointer pair identifies
the field for which the value is to be retrieved
and a pointer to the location where the field
value is to be stored.