Carbon


TXNGetTXNObjectControls

Header: MacTextEditor.h Carbon status: Supported

Gets the current formatting and privileges attributes (such as, justification, line direction, tab values, and read-only status) for a text object.

OSStatus TXNGetTXNObjectControls (
    TXNObject iTXNObject, 
    ItemCount iControlCount, 
    TXNControlTag iControlTags[], 
    TXNControlData oControlData[]
);
Parameter descriptions
iTXNObject

A variable of type TXNObject. Pass the text object that identifies the document to be activated.

iControlCount

A variable of type ItemCount. You use this to specify the number of iControlTags items in the array

iControlTags

An array of type TXNControlTag. You fill the array with “Formatting and Privileges Constants” values that specify the kind of formatting information you want returned in the oControlData array.

oControlData

An array of values of TXNControlData structures. On return, the array contains the information that was requested through the iControlTags array. Your application must allocate the oControlData array.

function result

A result code. TXNGetTXNObjectControls can also return parameter errors or noErr.

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 7/17/2000)