.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)