acdbDictNext

C++

struct resbuf * acdbDictNext(
    const ads_name dict, 
    int rewind
);

File

acedads.h

Description

Advances the program pointer to the next entry in the specified dictionary and returns a pointer to the entry as a linked list of result buffers with DXF group codes and values.

This function is similar to acdbTblSearch().

A dictionary is a container object that is functionally similar to symbol tables. An optional DXF sequence stores the current object's dictionary handle so that arbitrary drawing database objects can be attached to any object in a drawing.

Warning Only one global iterator is maintained for this function. If the program passes a new dictionary name to acdbDictNext() after traversal of the dictionary has begun, the original program pointer location is lost.

To obtain the master entity name, call acdbNamedObjDict().

When acdbDictNext() is called repeatedly, it normally returns the next entry in the specified table each time. If there are no more entries in the dictionary, acdbDictNext() returns NULL. It never returns deleted dictionary entries.

The behavior of this function can also be affected by the setnext argument in a successful call to acdbDictSearch().

When you begin scanning a table, supply a nonzero rewind argument to rewind the table and find its first entry.

When acdbDictNext() fails, it sets the system variable ERRNO to a value that indicates the reason for the failure.

Parameters