Cogent CIF Driver for Hilscher Fieldbus CIF Cards : Version 6.4
	Command Reference

`segmentDescribe`

segmentDescribe — describes the segments of a buffer.

Synopsis

(segmentDescribe card_id buffer [segment_id [count]])

Parameters

card_id: The ID of the card.
buffer: The ID of the buffer.
segment_id: (Optional) An index into the list of segment descriptions, specifying the first segment to describe. The default is 0, which returns the first segment and all remaining segment descriptions up to the limit of the message (IPC) buffer size. Segments do not actually have individual IDs, but are maintained in the order in which they were created (using segmentDefine).
count: (Optional) The number of segment descriptions to return. The default is 1.

Returns

A list of the block attributes associated with the specified block, formatted as follows:

(segmentDescribe card_id buffer seg_attrib₀ ... seg_attrib_N)

where a segment attribute description is formatted as:

(type read_write_mode offset length )

If the card_id or buffer are invalid, then an error is returned as:

(error error_string)

Description

This command requests a description of the segments defined (using the segmentDefine command) for a specified buffer. The segmentDescribe command is typically sent as a command and not used in the configuration file.


segmentDefine		statusPointDefine