d84ac66915f7b556137bd551ef6d7503d956ce89
[platform/upstream/fribidi.git] / doc / fribidi_charset_to_unicode.3
1 .\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man!
2 .\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST!
3 .TH "fribidi_charset_to_unicode" 3 "27 September 2019" "c2man fribidi-char-sets.h" "Programmer's Manual"
4 .SH "NAME"
5 fribidi_charset_to_unicode \- convert string to Unicode
6 .SH "SYNOPSIS"
7 .ft B
8 #include <fribidi.h>
9 .sp
10 extern FriBidiStrIndex fribidi_charset_to_unicode
11 .br
12 (
13 .br
14         FriBidiCharSet char_set,
15 .br
16         const char *s,
17 .br
18         FriBidiStrIndex len,
19 .br
20         FriBidiChar *us
21 .br
22 );
23 .ft R
24 .SH "PARAMETERS"
25 .TP
26 .B "FriBidiCharSet char_set"
27 Character set to convert from.
28 .sp
29 Possible values for a \fBFriBidiCharSet\fR are as follows:
30 .RS 0.75in
31 .PD 0
32 .ft B
33 .nr TL \w'FRIBIDI_CHAR_SET_ISO8859_6'u+0.2i
34 .ft R
35 .TP \n(TLu
36 \fBFRIBIDI_CHAR_SET_UTF8\fR
37 UTF-8 (Unicode).
38 .TP \n(TLu
39 \fBFRIBIDI_CHAR_SET_CAP_RTL\fR
40 CapRTL (Test).
41 .TP \n(TLu
42 \fBFRIBIDI_CHAR_SET_ISO8859_6\fR
43 ISO8859-6 (Arabic).
44 .TP \n(TLu
45 \fBFRIBIDI_CHAR_SET_ISO8859_8\fR
46 ISO8859-8 (Hebrew).
47 .TP \n(TLu
48 \fBFRIBIDI_CHAR_SET_CP1255\fR
49 CP1255 (MS Hebrew/Yiddish).
50 .TP \n(TLu
51 \fBFRIBIDI_CHAR_SET_CP1256\fR
52 CP1256 (MS Arabic).
53 .RE
54 .PD
55 .TP
56 .B "const char *s"
57 Input string encoded in char_set.
58 .TP
59 .B "FriBidiStrIndex len"
60 Input string length.
61 .TP
62 .B "FriBidiChar *us"
63 Output Unicode string.
64 .SH "DESCRIPTION"
65 This function converts an string from a character set, to a Unicode string.
66 .SH "RETURNS"
67 The length of the new string.
68 .SH "SEE ALSO"
69 fribidi_shape_arabic(3),
70 fribidi_get_par_direction(3),
71 fribidi_get_par_embedding_levels_ex(3),
72 fribidi_reorder_line(3),
73 fribidi_get_bidi_type(3),
74 fribidi_get_bidi_types(3),
75 fribidi_get_bidi_type_name(3),
76 fribidi_debug_status(3),
77 fribidi_set_debug(3),
78 fribidi_unicode_to_charset(3),
79 fribidi_parse_charset(3),
80 fribidi_mirroring_status(3),
81 fribidi_set_mirroring(3),
82 fribidi_reorder_nsm_status(3),
83 fribidi_set_reorder_nsm(3),
84 fribidi_log2vis_get_embedding_levels(3),
85 fribidi_get_type(3),
86 fribidi_get_type_internal(3),
87 fribidi_get_par_embedding_levels(3),
88 fribidi_join_arabic(3),
89 fribidi_get_joining_type(3),
90 fribidi_get_joining_types(3),
91 fribidi_get_joining_type_name(3),
92 fribidi_get_mirror_char(3),
93 fribidi_shape_mirroring(3),
94 fribidi_get_bracket(3),
95 fribidi_get_bracket_types(3),
96 fribidi_shape(3),
97 fribidi_remove_bidi_marks(3)