1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
|
.TH detect 3 2011-05-02 "libchardet manuals"
.\" Process with
.\" nroff -man detect.3
.\" 2011-05-02 JoungKyun Kim <htt://oops.org>
.\" $Id: detect.3 31 2014-02-10 13:04:09Z oops $
.SH NAME
detect \- Detecting character set and measuring accuracy of charset
.SH SYNOPSIS
.B "#include <chardet.h>"
.sp
.BI "short chardet (char * inbuf, DetectObj ** outbuf);"
.SH DESCRIPTION
Storing charset and accuracy of
.B inbuf to
.B outbuf
.TP
.B inbuf
.br
input string for detecting
.TP
.B outbuf
.br
Storing information of
.B inbuf
\[char46] The structure of
.B outbuf
is follows.
.nf
typedef struct DetectObject {
char * encoding;
float confidence;
} DetectObj;
.fi
The
.B outbuf
variable must be initialized by
.BI detect_obj_init
API before calling this detect api.
.SH "RETURN VALUE"
Returns following condition as case by case.
.TP
.B CHARDET_SUCCESS
.br
Detecting success
.TP
.B CHARDET_NO_RESULT
.br
Detection failure
.TP
.B CHARDET_NULL_OBJECT
.br
Don't initializing
.B outbuf
with
.BI chardet_obj_init
.TP
.B CHARDET_OUT_OF_MEMORY
.br
Occuring
.B "out of memory"
at internal API
.SH EXAMPLE
.nf
#include <chardet.h>
int main (void) {
DetectObj *obj;
if ( (obj = detect_obj_init ()) == NULL ) {
fprintf (stderr, "Memory Allocation failed\\n");
return CHARDET_MEM_ALLOCATED_FAIL;
}
switch (detect ("안녕하세요", &obj)) {
case CHARDET_OUT_OF_MEMORY :
fprintf (stderr, "On handle processing, occured out of memory\\n");
detect_obj_free (&obj);
return CHARDET_OUT_OF_MEMORY;
case CHARDET_NULL_OBJECT :
fprintf (stderr,
"2st argument of chardet() is must memory allocation "
"with detect_obj_init API\\n");
return CHARDET_NULL_OBJECT;
}
printf ("encoding: %s, confidence: %f\\n", obj->encoding, obj->confidence);
detect_obj_free (&obj);
return 0;
}
.fi
.SH AUTHORS
JoungKyun.Kim <http://oops.org>
.SH "BUG REPORTS"
Use QnA board on http://oops.org
.SH "SEE ALSO"
detect_handledata(3), detect_obj_init(3), detect_obj_free(3)
|