Topic       : TOS - The Operating System
Author      : 
Version     : tos.hyp (December 19, 2008)
Subject     : Programmieren/Atari
Nodes       : 3010
Index Size  : 93790
HCP-Version : 5
Compiled on : Atari
@charset    : atarist
@lang       : 
@default    : Title
@help       : 
@options    : +g -i -s +x +zz -t4
@width      : 70
View Ref-File7.6.35  vqt_char_index                                             TOS

 Name:         »Inquire character index« - Convert an index with 
               reference to given mappings.

 Opcode:       190 (Opcode 0)

 Syntax:       uint16_t vqt_char_index ( int16_t handle, uint16_t 
               scr_index, int16_t src_mode, int16_t dst_mode );

 Description:  The call vqt_char_index converts a passed character 
               index from and to the desired mapping encoding.

                Parameter  Meaning

                handle     Workstation identifier
                src_index  Index to be converted
                src_mode   Type of source mapping:
                            0 =     scr_index is a direct index
                            1 =     scr_index is an ASCII index
                            2 =     scr_index is a Unicode index
                dst_mode   Type of destination mapping:
                            0 = is a direct index
                            1 = is an ASCII index
                            2 = is a Unicode index

               Note: If you want to convert an index from ASCII to 
               ASCII, only the range from 32 to 255 is used. The 
               control codes are not translated, e.g. a call like 
               vqt_char_index( handle, 10, 1, 0 ) returns 0xffff.

               For example, to determine if the font contains a 
               character with Unicode 0x201e ("quotedblbase", DOUBLE 
               LOW-9 QUOTATION MARK), you should use the following 
               function:

               int16_t is_char_available (int16_t handle, uint16_t unicode)
               {
                  uint16_t dindex;
 
                  /* Translate unicode into a direct index */
                  dindex = vqt_char_index (handle, unicode, 2, 0);
 
                  if (dindex == 0xffff)
                     return (FALSE);        /* Character is available */
                  else
                     return (TRUE);         /* Not available */
               }

 Return value: This function returns the converted index, or the value 
               0xffff if conversion was not possible.

 Availability: since NVDI Version 4.00

 Group:        Inquire functions

 See Also:     Binding   vst_charmap