Cascade Driver for Hilscher Fieldbus CIF Cards: Version 4.1
Prev |  | Next

# typeDesc

typeDesc -- associates a descriptive string with a command name.

## Synopsis

    (typeDesc name string)

## Parameters

`name`

  An existing symbol name defined by the type command.

`string`

  The associated description string.

## Returns

`OK`, or `(error)` if the specified name is not a symbol defined by the type command.

## Description

This command associates a string, typically containing a syntax summary of the command, with the specified symbol. The symbol must have been defined by the type command. This command is used in a configuration file after the type command to which it corresponds. Its purpose is to provide helpful syntax information to an interactive user via the apropos command.

## Example

The following example adds a syntax summary description to the AI symbol defined in the example of the type command.

        (typeDesc AI "(AI point_name address_name eng_units_max)")

Prev | Home | Next
type | Up | updateBuffers

Copyright 1995-2002 by Cogent Real-Time Systems, Inc.