UTFConverter.h

This HTML document was auto-generated from UTFConverter.h

Method: UTFConverter_16to8

//=============================================================================
// Method:	UTFConverter_16to8
// Desc:	Convert a 0-terminated UTF-16 string to a 0-terminated UTF-8 string
// 
// Notes:
//			The returned string must be freed via a call to UTFConverter_free()
//=============================================================================
	DIRXML_EXPORT                                   
	char * IFAPI                                    //pointer to UTF-8 string (null if error)
	UTFConverter_16to8(                             
	    const unicode * utf16);                     //pointer to 0-terminated UTF-16 string

Method: UTFConverter_8to16

//=============================================================================
// Method:	UTFConverter_8to16
// Desc:	Convert a 0-terminated UTF-8 string to a 0-terminated UTF-16 string
// 
// Notes:
//			The returned string must be freed via a call to UTFConverter_free()
//=============================================================================
	DIRXML_EXPORT                                   
	unicode * IFAPI                                 //pointer to UTF-16 string (null if error)
	UTFConverter_8to16(                             
	    const char * utf8);                         //pointer to 0-terminated UTF-8 string

Method: UTFConverter_sizeTo8

//=============================================================================
// Method:	UTFConverter_sizeTo8
// Desc:	Convert a size_t value to string of null-terminated UTF-8 bytes.
// 
// Notes:
//			The returned string must be freed via a call to UTFConverter_free()
//
//			This can only handle sizes up to 32 bits.
//=============================================================================
	DIRXML_EXPORT                                   
	size_t IFAPI                                    //count of bytes placed into buffer
	UTFConverter_sizeTo8(                           
	    char * buffer,                              //buffer, at least 6 bytes, into which UTF-8 bytes are placed
	    size_t size);                               //size_t value to convert

Method: UTFConverter_sizeFrom8

//=============================================================================
// Method:	UTFConverter_sizeFrom8
// Desc:	Convert a string of UTF-8 bytes to a size_t value.
// 
// Notes:
//			This can only handle sizes up to 32 bits.
//=============================================================================
//those bytes that were read.
	DIRXML_EXPORT                                   
	size_t IFAPI                                    //size_t value from UTF-8 value
	UTFConverter_sizeFrom8(                         
	    const char ** utf8Size);                    //pointer to UTF-8 bytes, gets pointer past

Method: UTFConverter_free

//=============================================================================
// Method:	UTFConverter_free
// Desc:	Free a string returned from UTFConverter_16to8() or 
//			UTF_Converter_8to16()
// 
// Notes:
//=============================================================================
	DIRXML_EXPORT                                   
	void IFAPI                                      
	UTFConverter_free(                              
	    void * encodedData);                        //pointer to string returned converter function