IN_EnumerateDocumentPens

All Editions image\bltlrgsq_shg.gif  Related Functions  image\bltlrgsq_shg.gif  Example

The IN_EnumerateDocumentPens function identifies the total number of vector pens and their identifiers in the given document object.

Syntax

int IN_EnumerateDocumentPens( documentID, maxSize, pPenCnt, pPenIDs )

Input Parameters

Values

Meaning

IN_DOCUMENT documentID

docwinID or documentID

identifier of the document window or document to enumerate the pens for. See Remarks.

SHORT maxSize

number of entries in the pPenIds array

Output Parameters

Values

Meaning

SHORTPTR pPenCnt

0

no pens are being used or the format is not supported. See Remarks.

 

1 | 2 | ...

pointer to the number of pens in pPenIDs

SHORTPTR pPenIDs

penID1, penID2, …, penID256

pointer to the individual pen IDs between 0 and 256

Remarks

The documentID can be a layer, a page, a section, or the root of the document. This function will enumerate every pen below that portion of the document tree. For details about document structure, see Imagenation document structure.

Pen values belonging to deleted objects will not be returned.

This function will load all vector layers into memory, so with a large document this function might take a long time to execute.

This function only applies to AutoCAD DWG/DXF, Calcomp 906/907, HPGL, and DGN documents.

Release Information

Added to Imagenation for Windows in Release 6.0.

Not yet available in Imagenation for UNIX.

See also

Vector pens: Key concepts

Mapping vector pen lines