editorconfig_handle.h(3)

💖 editorconfig_handle.h — the header of the EditorConfig handle 💖

okay bestie, so this is a Library Functions Manual page, and its whole personality is editorconfig_handle.h: the header file of the EditorConfig handle. it's C, it's a handle, it's giving "pointer to a thing you don't need to know the guts of." periodt.

---

🌸 NAME 🌸

editorconfig_handle.h — Header file of EditorConfig handle. literally that's it, that's the whole name section 🫶

---

✨ SYNOPSIS ✨

🎀 Typedefs

• typedef void * editorconfig_handle — The editorconfig handle object type. yes it's a void *, no you may not peek inside, mind your business 💅

🦋 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. that's the vibe. that's the whole vibe check ✅

👑 Author

EditorConfig Team — the icons who made this happen, no cap 💜

---

💀 Function Documentation 💀

okay so this part is alphabetical-by-function and lowkey chaotic, so we're going in the exact order the page gives. buckle up bestie 🎀

🍓 int editorconfig_handle_destroy (editorconfig_handle h)

Destroy an editorconfig_handle object. rip little handle, you did amazing sweetie 😭

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. this is the "who snitched on the parse error" field, iykyk 👀

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. (zero-based!! do NOT forget, bestie, that's a classic 💀)
• 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. literally nothing. you get your info through the pointers, that's the whole bit ✨

---

🦋 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. number go up, you know how many you got 🔥

---

⭐ 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. all three come back through the pointers, so pass real ints or it's on you 🙈

---

🎀 editorconfig_handle editorconfig_handle_init (void )

Create and initialize a default editorconfig_handle object. this is the birth of a handle, main character origin story fr fr 👑

Return values

• NULL — Failed to create the editorconfig_handle object.
• non-NULL — The created editorconfig_handle object is returned.

always check for NULL before you go using it, bestie. that's not extra, that's self care 💅

---

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

the negative-number thing is the cute part: pass a value below 0 and that field just stays exactly how it was, untouched, unbothered, living its truth ✨

---

💅 Author 💅

Generated automatically by Doxygen for EditorConfig from the source code. yes bestie, a robot wrote the scaffolding, but the vibe? immaculate. iconic. no notes 🫶

---

so that's the whole page!! every function, every parameter, every NULL and non-NULL and zero and non-zero, all accounted for, nothing skipped, we ate and left zero crumbs 🍓

this was editorconfig_handle.h, section 3 of the Library Functions Manual, coming to you from the EditorConfig source — and the footer is just plain EditorConfig with the page name and no date on it, which is honestly a little mysterious of it, but we respect the mystery 💜 stay parsed, bestie 💖✨🎀🦋🌸💅