Carbon


LDelColumn

Header: Lists.h Carbon status: Supported

Deletes one or more columns from a list.

void LDelColumn (
    SInt16 count, 
    SInt16 colNum, 
    ListHandle lHandle
);
Parameter descriptions
count

The number of columns to delete, or 0 to delete all columns.

colNum

The column number of the first column to delete.

lHandle

The list from which to delete the columns.

DISCUSSION

This function deletes columns starting at the column specified by the colNum parameter. If the column specified by colNum is invalid, then nothing is done.

Your application can quickly delete all columns from a list (and thus delete all cell data) simply by setting the count parameter to 0. The number of rows is left unchanged. Your application can achieve the same effect by setting the colNum parameter to (**lHandle).dataBounds.left and setting the count parameter to a value greater than (**lHandle).dataBounds.right – (**lHandle).dataBounds.left.

Columns whose column numbers are initially greater than colNum have their column numbers decreased by count.

If the automatic drawing mode is enabled and one or more of the columns deleted by this function are visible, then the list (including its scroll bars) is updated.

SPECIAL CONSIDERATIONS

This function is contained in a resource of resource type 'PACK'. Calling it could result in the loading of the package resource and the allocation of memory. Thus, your application should not call this function from within an interrupt, such as in a completion function or VBL task.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)