.TH "editorconfig_handle.h" 3 "EditorConfig" \" -*- nroff -*- .ad l .nh .SH NAME editorconfig_handle.h \- Header file of EditorConfig handle\&. .SH SYNOPSIS .br .PP .SS "Typedefs" .in +1c .ti -1c .RI "typedef void * \fBeditorconfig_handle\fP" .br .RI "The editorconfig handle object type\&. " .in -1c .SS "Functions" .in +1c .ti -1c .RI "\fBeditorconfig_handle\fP \fBeditorconfig_handle_init\fP (void)" .br .RI "Create and intialize a default editorconfig_handle object\&. " .ti -1c .RI "int \fBeditorconfig_handle_destroy\fP (\fBeditorconfig_handle\fP h)" .br .RI "Destroy an editorconfig_handle object\&. " .ti -1c .RI "const char * \fBeditorconfig_handle_get_err_file\fP (\fBeditorconfig_handle\fP h)" .br .RI "Get the err_file field of an editorconfig_handle object\&. " .ti -1c .RI "void \fBeditorconfig_handle_get_version\fP (const \fBeditorconfig_handle\fP h, int *major, int *minor, int *patch)" .br .RI "Get the version fields of an editorconfig_handle object\&. " .ti -1c .RI "void \fBeditorconfig_handle_set_version\fP (const \fBeditorconfig_handle\fP h, int major, int minor, int patch)" .br .RI "Set the version fields of an editorconfig_handle object\&. " .ti -1c .RI "void \fBeditorconfig_handle_set_conf_file_name\fP (\fBeditorconfig_handle\fP h, const char *conf_file_name)" .br .RI "Set the conf_file_name field of an editorconfig_handle object\&. " .ti -1c .RI "const char * \fBeditorconfig_handle_get_conf_file_name\fP (const \fBeditorconfig_handle\fP h)" .br .RI "Get the conf_file_name field of an editorconfig_handle object\&. " .ti -1c .RI "void \fBeditorconfig_handle_get_name_value\fP (const \fBeditorconfig_handle\fP h, int n, const char **name, const char **value)" .br .RI "Get the nth name and value fields of an editorconfig_handle object\&. " .ti -1c .RI "int \fBeditorconfig_handle_get_name_value_count\fP (const \fBeditorconfig_handle\fP h)" .br .RI "Get the count of name and value fields of an editorconfig_handle object\&. " .in -1c .SH "Detailed Description" .PP Header file of EditorConfig handle\&. .PP \fBAuthor\fP .RS 4 EditorConfig Team .RE .PP .SH "Function Documentation" .PP .SS "int editorconfig_handle_destroy (\fBeditorconfig_handle\fP h)" .PP Destroy an editorconfig_handle object\&. .PP \fBParameters\fP .RS 4 \fIh\fP The editorconfig_handle object needs to be destroyed\&. .RE .PP \fBReturn values\fP .RS 4 \fIzero\fP The editorconfig_handle object is destroyed successfully\&. .br \fInon-zero\fP Failed to destroy the editorconfig_handle object\&. .RE .PP .SS "const char * editorconfig_handle_get_conf_file_name (const \fBeditorconfig_handle\fP h)" .PP Get the conf_file_name field of an editorconfig_handle object\&. .PP \fBParameters\fP .RS 4 \fIh\fP The editorconfig_handle object whose conf_file_name field needs to be obtained\&. .RE .PP \fBReturns\fP .RS 4 The value of the conf_file_name field of the editorconfig_handle object\&. .RE .PP .SS "const char * editorconfig_handle_get_err_file (\fBeditorconfig_handle\fP h)" .PP Get the err_file field of an editorconfig_handle object\&. .PP \fBParameters\fP .RS 4 \fIh\fP The editorconfig_handle object whose err_file needs to be obtained\&. .RE .PP \fBReturn values\fP .RS 4 \fINULL\fP No error file exists\&. .br \fInon-NULL\fP The pointer to the path of the file caused the parsing error is returned\&. .RE .PP .SS "void editorconfig_handle_get_name_value (const \fBeditorconfig_handle\fP h, int n, const char ** name, const char ** value)" .PP Get the nth name and value fields of an editorconfig_handle object\&. .PP \fBParameters\fP .RS 4 \fIh\fP The editorconfig_handle object whose name and value fields need to be obtained\&. .br \fIn\fP The zero-based index of the name and value fields to be obtained\&. .br \fIname\fP If not null, *name will be set to point to the obtained name\&. .br \fIvalue\fP If not null, *value will be set to point to the obtained value\&. .RE .PP \fBReturns\fP .RS 4 None\&. .RE .PP .SS "int editorconfig_handle_get_name_value_count (const \fBeditorconfig_handle\fP h)" .PP Get the count of name and value fields of an editorconfig_handle object\&. .PP \fBParameters\fP .RS 4 \fIh\fP The editorconfig_handle object whose count of name and value fields need to be obtained\&. .RE .PP \fBReturns\fP .RS 4 the count of name and value fields of the editorconfig_handle object\&. .RE .PP .SS "void editorconfig_handle_get_version (const \fBeditorconfig_handle\fP h, int * major, int * minor, int * patch)" .PP Get the version fields of an editorconfig_handle object\&. .PP \fBParameters\fP .RS 4 \fIh\fP The editorconfig_handle object whose version field need to be obtained\&. .br \fImajor\fP If not null, the integer pointed by major will be filled with the major version field of the editorconfig_handle object\&. .br \fIminor\fP If not null, the integer pointed by minor will be filled with the minor version field of the editorconfig_handle object\&. .br \fIpatch\fP If not null, the integer pointed by patch will be filled with the patch version field of the editorconfig_handle object\&. .RE .PP \fBReturns\fP .RS 4 None\&. .RE .PP .SS "\fBeditorconfig_handle\fP editorconfig_handle_init (void )" .PP Create and intialize a default editorconfig_handle object\&. .PP \fBReturn values\fP .RS 4 \fINULL\fP Failed to create the editorconfig_handle object\&. .br \fInon-NULL\fP The created editorconfig_handle object is returned\&. .RE .PP .SS "void editorconfig_handle_set_conf_file_name (\fBeditorconfig_handle\fP h, const char * conf_file_name)" .PP Set the conf_file_name field of an editorconfig_handle object\&. .PP \fBParameters\fP .RS 4 \fIh\fP The editorconfig_handle object whose conf_file_name field needs to be set\&. .br \fIconf_file_name\fP The new value of the conf_file_name field of the editorconfig_handle object\&. .RE .PP \fBReturns\fP .RS 4 None\&. .RE .PP .SS "void editorconfig_handle_set_version (const \fBeditorconfig_handle\fP h, int major, int minor, int patch)" .PP Set the version fields of an editorconfig_handle object\&. .PP \fBParameters\fP .RS 4 \fIh\fP The editorconfig_handle object whose version fields need to be set\&. .br \fImajor\fP If not less than 0, the major version field will be set to major\&. If this parameter is less than 0, the major version field of the editorconfig_handle object will remain unchanged\&. .br \fIminor\fP If not less than 0, the minor version field will be set to minor\&. If this parameter is less than 0, the minor version field of the editorconfig_handle object will remain unchanged\&. .br \fIpatch\fP If not less than 0, the patch version field will be set to patch\&. If this parameter is less than 0, the patch version field of the editorconfig_handle object will remain unchanged\&. .RE .PP \fBReturns\fP .RS 4 None\&. .RE .PP .SH "Author" .PP Generated automatically by Doxygen for EditorConfig from the source code\&.