This function attempts to retrieve a file's character encoding. |
Examples
|
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
file | string | Required The file. | A valid file path, relative to the user's home directory. | public_html/index.html |
Return | Type | Description | Possible values | Example | |
---|---|---|---|---|---|
encoding | string | The file's character encoding. | Any cPanel-known character encoding. |
| |
file | string | The file's path. | An absolute file path. | /home/user/etc/example/passwd | |
reason | string | A reason for failure.
| A string that describes the error. | This is an error message. | |
result | Boolean | Whether the function succeeded.
|
| 1 |
Function information
About this moduleThe About cPanel API 2
Find a functionRelated functions
|