Carbon


TXNSetBackground

Header: MacTextEditor.h Carbon status: Supported

Set the type of background on which the text object’s data is drawn.

OSStatus TXNSetBackground (
    TXNObject iTXNObject, 
    TXNBackground *iBackgroundInfo
);
Parameter descriptions
iTXNObject

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

iBackgroundInfo

A pointer to a variable of type TXNBackground that describes the background.

function result

A result code. TXNSetBackground can also return parameter errors.

VERSION NOTES

MLTE version 1.1 and earlier supports only color as the background.

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)