Mac OS 9
Data Structures | Typedefs | Enumerations | Functions
TextEncodingConverter.h File Reference
Font

Text Encoding Conversion Interfaces. More...

#include <MacTypes.h>
#include <TextCommon.h>

Go to the source code of this file.

Data Structures

struct  TECConversionInfo
 

Typedefs

typedef OSType TECPluginSignature
 
typedef UInt32 TECPluginVersion
 
typedef struct OpaqueTECObjectRef * TECObjectRef
 
typedef struct OpaqueTECSnifferObjectRef * TECSnifferObjectRef
 
typedef OSType TECPluginSig
 
typedef struct TECConversionInfo TECConversionInfo
 

Enumerations

enum  {
  kTECSignature = FOUR_CHAR_CODE('encv') , kTECUnicodePluginSignature = FOUR_CHAR_CODE('puni') , kTECJapanesePluginSignature = FOUR_CHAR_CODE('pjpn') , kTECChinesePluginSignature = FOUR_CHAR_CODE('pzho') ,
  kTECKoreanPluginSignature = FOUR_CHAR_CODE('pkor')
}
 

Functions

OSStatus TECCountAvailableTextEncodings (ItemCount *numberEncodings)
 
OSStatus TECGetAvailableTextEncodings (TextEncoding availableEncodings[], ItemCount maxAvailableEncodings, ItemCount *actualAvailableEncodings)
 
OSStatus TECCountDirectTextEncodingConversions (ItemCount *numberOfEncodings)
 
OSStatus TECGetDirectTextEncodingConversions (TECConversionInfo availableConversions[], ItemCount maxAvailableConversions, ItemCount *actualAvailableConversions)
 
OSStatus TECCountDestinationTextEncodings (TextEncoding inputEncoding, ItemCount *numberOfEncodings)
 
OSStatus TECGetDestinationTextEncodings (TextEncoding inputEncoding, TextEncoding destinationEncodings[], ItemCount maxDestinationEncodings, ItemCount *actualDestinationEncodings)
 
OSStatus TECGetTextEncodingInternetName (TextEncoding textEncoding, Str255 encodingName)
 
OSStatus TECGetTextEncodingFromInternetName (TextEncoding *textEncoding, ConstStr255Param encodingName)
 
OSStatus TECCreateConverter (TECObjectRef *newEncodingConverter, TextEncoding inputEncoding, TextEncoding outputEncoding)
 
OSStatus TECCreateConverterFromPath (TECObjectRef *newEncodingConverter, const TextEncoding inPath[], ItemCount inEncodings)
 
OSStatus TECDisposeConverter (TECObjectRef newEncodingConverter)
 
OSStatus TECClearConverterContextInfo (TECObjectRef encodingConverter)
 
OSStatus TECConvertText (TECObjectRef encodingConverter, ConstTextPtr inputBuffer, ByteCount inputBufferLength, ByteCount *actualInputLength, TextPtr outputBuffer, ByteCount outputBufferLength, ByteCount *actualOutputLength)
 
OSStatus TECFlushText (TECObjectRef encodingConverter, TextPtr outputBuffer, ByteCount outputBufferLength, ByteCount *actualOutputLength)
 
OSStatus TECCountSubTextEncodings (TextEncoding inputEncoding, ItemCount *numberOfEncodings)
 
OSStatus TECGetSubTextEncodings (TextEncoding inputEncoding, TextEncoding subEncodings[], ItemCount maxSubEncodings, ItemCount *actualSubEncodings)
 
OSStatus TECGetEncodingList (TECObjectRef encodingConverter, ItemCount *numEncodings, Handle *encodingList)
 
OSStatus TECCreateOneToManyConverter (TECObjectRef *newEncodingConverter, TextEncoding inputEncoding, ItemCount numOutputEncodings, const TextEncoding outputEncodings[])
 
OSStatus TECConvertTextToMultipleEncodings (TECObjectRef encodingConverter, ConstTextPtr inputBuffer, ByteCount inputBufferLength, ByteCount *actualInputLength, TextPtr outputBuffer, ByteCount outputBufferLength, ByteCount *actualOutputLength, TextEncodingRun outEncodingsBuffer[], ItemCount maxOutEncodingRuns, ItemCount *actualOutEncodingRuns)
 
OSStatus TECFlushMultipleEncodings (TECObjectRef encodingConverter, TextPtr outputBuffer, ByteCount outputBufferLength, ByteCount *actualOutputLength, TextEncodingRun outEncodingsBuffer[], ItemCount maxOutEncodingRuns, ItemCount *actualOutEncodingRuns)
 
OSStatus TECCountWebTextEncodings (RegionCode locale, ItemCount *numberEncodings)
 
OSStatus TECGetWebTextEncodings (RegionCode locale, TextEncoding availableEncodings[], ItemCount maxAvailableEncodings, ItemCount *actualAvailableEncodings)
 
OSStatus TECCountMailTextEncodings (RegionCode locale, ItemCount *numberEncodings)
 
OSStatus TECGetMailTextEncodings (RegionCode locale, TextEncoding availableEncodings[], ItemCount maxAvailableEncodings, ItemCount *actualAvailableEncodings)
 
OSStatus TECCountAvailableSniffers (ItemCount *numberOfEncodings)
 
OSStatus TECGetAvailableSniffers (TextEncoding availableSniffers[], ItemCount maxAvailableSniffers, ItemCount *actualAvailableSniffers)
 
OSStatus TECCreateSniffer (TECSnifferObjectRef *encodingSniffer, TextEncoding testEncodings[], ItemCount numTextEncodings)
 
OSStatus TECSniffTextEncoding (TECSnifferObjectRef encodingSniffer, TextPtr inputBuffer, ByteCount inputBufferLength, TextEncoding testEncodings[], ItemCount numTextEncodings, ItemCount numErrsArray[], ItemCount maxErrs, ItemCount numFeaturesArray[], ItemCount maxFeatures)
 
OSStatus TECDisposeSniffer (TECSnifferObjectRef encodingSniffer)
 
OSStatus TECClearSnifferContextInfo (TECSnifferObjectRef encodingSniffer)
 
OSStatus TECSetBasicOptions (TECObjectRef encodingConverter, OptionBits controlFlags)
 

Detailed Description

Text Encoding Conversion Interfaces.

Introduced In: Mac OS 9.0
Avaliable From: Universal Interfaces 3.4.1
Copyright: © 1994-2001 by Apple Computer, Inc., all rights reserved.

For bug reports, consult the following page on the World Wide Web: 

http://developer.apple.com/bugreporter/

Typedef Documentation

◆ TECObjectRef

typedef struct OpaqueTECObjectRef* TECObjectRef

converter object reference

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

plugin signatures

Function Documentation

◆ TECClearConverterContextInfo()

OSStatus TECClearConverterContextInfo ( TECObjectRef  encodingConverter)

convert text encodings TECClearConverterContextInfo()

Non-Carbon CFM: in TextEncodingConverter 1.2 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECClearSnifferContextInfo()

OSStatus TECClearSnifferContextInfo ( TECSnifferObjectRef  encodingSniffer)

TECClearSnifferContextInfo()

Non-Carbon CFM: in TextEncodingConverter 1.2 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECConvertText()

OSStatus TECConvertText ( TECObjectRef  encodingConverter,
ConstTextPtr  inputBuffer,
ByteCount  inputBufferLength,
ByteCount *  actualInputLength,
TextPtr  outputBuffer,
ByteCount  outputBufferLength,
ByteCount *  actualOutputLength 
)

TECConvertText()

Non-Carbon CFM: in TextEncodingConverter 1.2 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECConvertTextToMultipleEncodings()

OSStatus TECConvertTextToMultipleEncodings ( TECObjectRef  encodingConverter,
ConstTextPtr  inputBuffer,
ByteCount  inputBufferLength,
ByteCount *  actualInputLength,
TextPtr  outputBuffer,
ByteCount  outputBufferLength,
ByteCount *  actualOutputLength,
TextEncodingRun  outEncodingsBuffer[],
ItemCount  maxOutEncodingRuns,
ItemCount *  actualOutEncodingRuns 
)

TECConvertTextToMultipleEncodings()

Non-Carbon CFM: in TextEncodingConverter 1.2 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECCountAvailableSniffers()

OSStatus TECCountAvailableSniffers ( ItemCount *  numberOfEncodings)

examine text encodings TECCountAvailableSniffers()

Non-Carbon CFM: in TextEncodingConverter 1.2 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECCountAvailableTextEncodings()

OSStatus TECCountAvailableTextEncodings ( ItemCount *  numberEncodings)

return number of encodings types supported by user's configuraton of the encoding converter TECCountAvailableTextEncodings()

Non-Carbon CFM: in TextEncodingConverter 1.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECCountDestinationTextEncodings()

OSStatus TECCountDestinationTextEncodings ( TextEncoding  inputEncoding,
ItemCount *  numberOfEncodings 
)

return number of encodings a given encoding can be converter into TECCountDestinationTextEncodings()

Non-Carbon CFM: in TextEncodingConverter 1.2 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECCountDirectTextEncodingConversions()

OSStatus TECCountDirectTextEncodingConversions ( ItemCount *  numberOfEncodings)

return number of from-to encoding conversion pairs supported
TECCountDirectTextEncodingConversions()

Non-Carbon CFM: in TextEncodingConverter 1.2 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECCountMailTextEncodings()

OSStatus TECCountMailTextEncodings ( RegionCode  locale,
ItemCount *  numberEncodings 
)

TECCountMailTextEncodings()

Non-Carbon CFM: in TextEncodingConverter 1.2 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECCountSubTextEncodings()

OSStatus TECCountSubTextEncodings ( TextEncoding  inputEncoding,
ItemCount *  numberOfEncodings 
)

one-to-many routines TECCountSubTextEncodings()

Non-Carbon CFM: in TextEncodingConverter 1.2 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECCountWebTextEncodings()

OSStatus TECCountWebTextEncodings ( RegionCode  locale,
ItemCount *  numberEncodings 
)

international internet info TECCountWebTextEncodings()

Non-Carbon CFM: in TextEncodingConverter 1.2 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECCreateConverter()

OSStatus TECCreateConverter ( TECObjectRef *  newEncodingConverter,
TextEncoding  inputEncoding,
TextEncoding  outputEncoding 
)

create/dispose converters TECCreateConverter()

Non-Carbon CFM: in TextEncodingConverter 1.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECCreateConverterFromPath()

OSStatus TECCreateConverterFromPath ( TECObjectRef *  newEncodingConverter,
const TextEncoding  inPath[],
ItemCount  inEncodings 
)

TECCreateConverterFromPath()

Non-Carbon CFM: in TextEncodingConverter 1.2 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECCreateOneToManyConverter()

OSStatus TECCreateOneToManyConverter ( TECObjectRef *  newEncodingConverter,
TextEncoding  inputEncoding,
ItemCount  numOutputEncodings,
const TextEncoding  outputEncodings[] 
)

TECCreateOneToManyConverter()

Non-Carbon CFM: in TextEncodingConverter 1.2 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECCreateSniffer()

OSStatus TECCreateSniffer ( TECSnifferObjectRef *  encodingSniffer,
TextEncoding  testEncodings[],
ItemCount  numTextEncodings 
)

TECCreateSniffer()

Non-Carbon CFM: in TextEncodingConverter 1.2 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECDisposeConverter()

OSStatus TECDisposeConverter ( TECObjectRef  newEncodingConverter)

TECDisposeConverter()

Non-Carbon CFM: in TextEncodingConverter 1.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECDisposeSniffer()

OSStatus TECDisposeSniffer ( TECSnifferObjectRef  encodingSniffer)

TECDisposeSniffer()

Non-Carbon CFM: in TextEncodingConverter 1.2 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECFlushMultipleEncodings()

OSStatus TECFlushMultipleEncodings ( TECObjectRef  encodingConverter,
TextPtr  outputBuffer,
ByteCount  outputBufferLength,
ByteCount *  actualOutputLength,
TextEncodingRun  outEncodingsBuffer[],
ItemCount  maxOutEncodingRuns,
ItemCount *  actualOutEncodingRuns 
)

TECFlushMultipleEncodings()

Non-Carbon CFM: in TextEncodingConverter 1.2 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECFlushText()

OSStatus TECFlushText ( TECObjectRef  encodingConverter,
TextPtr  outputBuffer,
ByteCount  outputBufferLength,
ByteCount *  actualOutputLength 
)

TECFlushText()

Non-Carbon CFM: in TextEncodingConverter 1.2 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECGetAvailableSniffers()

OSStatus TECGetAvailableSniffers ( TextEncoding  availableSniffers[],
ItemCount  maxAvailableSniffers,
ItemCount *  actualAvailableSniffers 
)

TECGetAvailableSniffers()

Non-Carbon CFM: in TextEncodingConverter 1.2 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECGetAvailableTextEncodings()

OSStatus TECGetAvailableTextEncodings ( TextEncoding  availableEncodings[],
ItemCount  maxAvailableEncodings,
ItemCount *  actualAvailableEncodings 
)

fill in an array of type TextEncoding passed in by the user with types of encodings the current configuration of the encoder can handle. TECGetAvailableTextEncodings()

Non-Carbon CFM: in TextEncodingConverter 1.2 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECGetDestinationTextEncodings()

OSStatus TECGetDestinationTextEncodings ( TextEncoding  inputEncoding,
TextEncoding  destinationEncodings[],
ItemCount  maxDestinationEncodings,
ItemCount *  actualDestinationEncodings 
)

fill in an array of type TextEncodingPair passed in by the user with types of encodings pairs the current configuration of the encoder can handle. TECGetDestinationTextEncodings()

Non-Carbon CFM: in TextEncodingConverter 1.2 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECGetDirectTextEncodingConversions()

OSStatus TECGetDirectTextEncodingConversions ( TECConversionInfo  availableConversions[],
ItemCount  maxAvailableConversions,
ItemCount *  actualAvailableConversions 
)

fill in an array of type TextEncodingPair passed in by the user with types of encoding pairs the current configuration of the encoder can handle. TECGetDirectTextEncodingConversions()

Non-Carbon CFM: in TextEncodingConverter 1.2 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECGetEncodingList()

OSStatus TECGetEncodingList ( TECObjectRef  encodingConverter,
ItemCount *  numEncodings,
Handle *  encodingList 
)

TECGetEncodingList()

Non-Carbon CFM: in TextEncodingConverter 1.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECGetMailTextEncodings()

OSStatus TECGetMailTextEncodings ( RegionCode  locale,
TextEncoding  availableEncodings[],
ItemCount  maxAvailableEncodings,
ItemCount *  actualAvailableEncodings 
)

TECGetMailTextEncodings()

Non-Carbon CFM: in TextEncodingConverter 1.2 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECGetSubTextEncodings()

OSStatus TECGetSubTextEncodings ( TextEncoding  inputEncoding,
TextEncoding  subEncodings[],
ItemCount  maxSubEncodings,
ItemCount *  actualSubEncodings 
)

TECGetSubTextEncodings()

Non-Carbon CFM: in TextEncodingConverter 1.2 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECGetTextEncodingFromInternetName()

OSStatus TECGetTextEncodingFromInternetName ( TextEncoding *  textEncoding,
ConstStr255Param  encodingName 
)

TECGetTextEncodingFromInternetName()

Non-Carbon CFM: in TextEncodingConverter 1.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECGetTextEncodingInternetName()

OSStatus TECGetTextEncodingInternetName ( TextEncoding  textEncoding,
Str255  encodingName 
)

get info about a text encoding TECGetTextEncodingInternetName()

Non-Carbon CFM: in TextEncodingConverter 1.1 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECGetWebTextEncodings()

OSStatus TECGetWebTextEncodings ( RegionCode  locale,
TextEncoding  availableEncodings[],
ItemCount  maxAvailableEncodings,
ItemCount *  actualAvailableEncodings 
)

TECGetWebTextEncodings()

Non-Carbon CFM: in TextEncodingConverter 1.2 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TECSetBasicOptions()

OSStatus TECSetBasicOptions ( TECObjectRef  encodingConverter,
OptionBits  controlFlags 
)

TECSetBasicOptions()

Non-Carbon CFM: in TextEncodingConverter 1.5 and later
Carbon Lib: not available
Mac OS X: not available

◆ TECSniffTextEncoding()

OSStatus TECSniffTextEncoding ( TECSnifferObjectRef  encodingSniffer,
TextPtr  inputBuffer,
ByteCount  inputBufferLength,
TextEncoding  testEncodings[],
ItemCount  numTextEncodings,
ItemCount  numErrsArray[],
ItemCount  maxErrs,
ItemCount  numFeaturesArray[],
ItemCount  maxFeatures 
)

TECSniffTextEncoding()

Non-Carbon CFM: in TextEncodingConverter 1.2 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later