Routines (alphabetical) > Object Classes > File Format Object Classes > IDLffDXF::GetContents

# IDLffDXF::GetContents

Syntax | Return Value | Arguments | Keywords | Version History

The IDLffDXF::GetContents function method returns a description of the content of the DXF file.

See the Examples in the GetEntity method for an illustration of the difference between the GetContents and the GetEntity methods.

Note: The Read or PutEntity methods must have been called previously for the results of this method to be valid.

Valid DXF ENTITY Types | DXF_TYPE ( 0=default)
ARC | 1
CIRCLE | 2
ELLIPSE | 3
LINE | 4
LINE3D | 5
TRACE | 6
POLYLINE | 7
LWPOLYLINE | 8
POLYGON | 9
FACE3D | 10
SOLID | 11
RAY | 12
XLINE | 13
TEXT | 14
MTEXT | 15
POINT | 16
SPLINE | 17
BLOCK | 18
INSERT | 19
LAYER | 20

This object uses a small number of IDL named structures to return the data associated which each entity. This means that several of these DXF types are returned in the same structures, using different values of the DXF_TYPE field. The mapping of DXF entities to IDL named structures is as follows (each of these structures is documented in the GetEntity method):

IDL Structure | DXF Entity
IDL_DXF_ELLIPSE | arc, circle, ellipse
IDL_DXF_POLYLINE | line, line3d, trace, polyline, lwpolyline
IDL_DXF_POLYGON | face3d, solid, polyline (3-d mesh)
IDL_DXF_POINT | point
IDL_DXF_XLINE | ray, xline
IDL_DXF_SPLINE | spline
IDL_DXF_TEXT | text, multitext
IDL_DXF_BLOCK | block
IDL_DXF_INSERT | insert
IDL_DXF_LAYER | layer

## Syntax

Result =Obj->[IDLffDXF::]GetContents( [Filter][, BLOCK=string] [, COUNT=variable] [, LAYER=string] )

## Return Value

Returns an integer array containing the DXF entity type codes and the number of occurrences of each entity type contained in the object

## Arguments

### Filter

An integer array of the DXF entity types to which the return types are restricted. If set, Result can contain only types given in this argument and count will also reflect that restriction.

## Keywords

### BLOCK

Set this keyword to a string value containing the block name to obtain the entities from. The default is all blocks.

### COUNT

A long array containing the number of each entity type contained within the DXF object. If the Filter argument was provided, the numbers reflect the reduced set of entities caused by the Filter argument.

### LAYER

Set this keyword to a string value containing the layer name to obtain the entities from. The default is all layers.

## Version History

5.2 | Introduced