---
name: "editorconfig_handle.h"
section: "3"
platform: "linux"
package: "editorconfig-core-c"
version: "0.12.11-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/editorconfig_handle.h"
---

# editorconfig\_handle.h(3)

Header file of EditorConfig handle.

## NAME

editorconfig\_handle.h - Header file of EditorConfig handle.

## SYNOPSIS

### Typedefs

typedef void \* **editorconfig\_handle**\
 The editorconfig handle object type.

### Functions

**editorconfig\_handle** **editorconfig\_handle\_init** (void)\
 Create and initialize a default **editorconfig\_handle** object.  int **editorconfig\_handle\_destroy** (**editorconfig\_handle** h)\
 Destroy an **editorconfig\_handle** object.  const char \* **editorconfig\_handle\_get\_err\_file** (**editorconfig\_handle** h)\
 Get the err\_file field of an **editorconfig\_handle** object.  void **editorconfig\_handle\_get\_version** (const **editorconfig\_handle** h, int \*major, int \*minor, int \*patch)\
 Get the version fields of an **editorconfig\_handle** object.  void **editorconfig\_handle\_set\_version** (const **editorconfig\_handle** h, int major, int minor, int patch)\
 Set the version fields of an **editorconfig\_handle** object.  void **editorconfig\_handle\_set\_conf\_file\_name** (**editorconfig\_handle** h, const char \*conf\_file\_name)\
 Set the conf\_file\_name field of an **editorconfig\_handle** object.  const char \* **editorconfig\_handle\_get\_conf\_file\_name** (const **editorconfig\_handle** h)\
 Get the conf\_file\_name field of an **editorconfig\_handle** object.  void **editorconfig\_handle\_get\_name\_value** (const **editorconfig\_handle** h, int n, const char \*\*name, const char \*\*value)\
 Get the nth name and value fields of an **editorconfig\_handle** object.  int **editorconfig\_handle\_get\_name\_value\_count** (const **editorconfig\_handle** h)\
 Get the count of name and value fields of an **editorconfig\_handle** object.

## Detailed Description

Header file of EditorConfig handle.

**Author**

EditorConfig Team

## Function Documentation

### int editorconfig\_handle\_destroy (editorconfig\_handle h)

Destroy an **editorconfig\_handle** object.

**Parameters**

*h* The **editorconfig\_handle** object needs to be destroyed.

**Return values**

*zero* The **editorconfig\_handle** object is destroyed successfully.\
 *non-zero* Failed to destroy the **editorconfig\_handle** object.

### const char \* editorconfig\_handle\_get\_conf\_file\_name (const editorconfig\_handle h)

Get the conf\_file\_name field of an **editorconfig\_handle** object.

**Parameters**

*h* The **editorconfig\_handle** object whose conf\_file\_name field needs to be obtained.

**Returns**

The value of the conf\_file\_name field of the **editorconfig\_handle** object.

### const char \* editorconfig\_handle\_get\_err\_file (editorconfig\_handle h)

Get the err\_file field of an **editorconfig\_handle** object.

**Parameters**

*h* The **editorconfig\_handle** object whose err\_file needs to be obtained.

**Return values**

*NULL* No error file exists.\
 *non-NULL* The pointer to the path of the file caused the parsing error is returned.

### void editorconfig\_handle\_get\_name\_value (const editorconfig\_handle h, int n, const char \*\* name, const char \*\* value)

Get the nth name and value fields of an **editorconfig\_handle** object.

**Parameters**

*h* The **editorconfig\_handle** object whose name and value fields need to be obtained.\
 *n* The zero-based index of the name and value fields to be obtained.\
 *name* If not null, \*name will be set to point to the obtained name.\
 *value* If not null, \*value will be set to point to the obtained value.

**Returns**

None.

### int editorconfig\_handle\_get\_name\_value\_count (const editorconfig\_handle h)

Get the count of name and value fields of an **editorconfig\_handle** object.

**Parameters**

*h* The **editorconfig\_handle** object whose count of name and value fields need to be obtained.

**Returns**

the count of name and value fields of the **editorconfig\_handle** object.

### void editorconfig\_handle\_get\_version (const editorconfig\_handle h, int \* major, int \* minor, int \* patch)

Get the version fields of an **editorconfig\_handle** object.

**Parameters**

*h* The **editorconfig\_handle** object whose version field need to be obtained.\
 *major* If not null, the integer pointed by major will be filled with the major version field of the **editorconfig\_handle** object.\
 *minor* If not null, the integer pointed by minor will be filled with the minor version field of the **editorconfig\_handle** object.\
 *patch* If not null, the integer pointed by patch will be filled with the patch version field of the **editorconfig\_handle** object.

**Returns**

None.

### editorconfig\_handle editorconfig\_handle\_init (void )

Create and initialize a default **editorconfig\_handle** object.

**Return values**

*NULL* Failed to create the **editorconfig\_handle** object.\
 *non-NULL* The created **editorconfig\_handle** object is returned.

### void editorconfig\_handle\_set\_conf\_file\_name (editorconfig\_handle h, const char \* conf\_file\_name)

Set the conf\_file\_name field of an **editorconfig\_handle** object.

**Parameters**

*h* The **editorconfig\_handle** object whose conf\_file\_name field needs to be set.\
 *conf\_file\_name* The new value of the conf\_file\_name field of the **editorconfig\_handle** object.

**Returns**

None.

### void editorconfig\_handle\_set\_version (const editorconfig\_handle h, int major, int minor, int patch)

Set the version fields of an **editorconfig\_handle** object.

**Parameters**

*h* The **editorconfig\_handle** object whose version fields need to be set.\
 *major* 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.\
 *minor* 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.\
 *patch* 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.

**Returns**

None.

## Author

Generated automatically by Doxygen for EditorConfig from the source code.