forked from SerenityOS/serenity
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Base: Add documentation for
get_process_name
`set_process_name` has a getter pair (which it links to); lets document it. Solves SerenityOS#6007.
- Loading branch information
1 parent
b6093ae
commit b2c952a
Showing
1 changed file
with
28 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
## Name | ||
|
||
get\_process\_name - get the process name | ||
|
||
## Synopsis | ||
|
||
```**c++ | ||
#include <unistd.h> | ||
int get_process_name(char* buffer, int buffer_length); | ||
``` | ||
|
||
## Description | ||
|
||
`get_process_name()` places the current process name into the provided `buffer`. | ||
|
||
## Pledge | ||
|
||
In pledged programs, the `stdio` promise is required for this system call. | ||
|
||
## Errors | ||
|
||
* `EFAULT`: the process name could not be copied into the buffer. | ||
* `ENAMETOOLONG`: `buffer_length` is too short. | ||
|
||
## See also | ||
|
||
* [`set_process_name`(2)](../man2/set_process_name.md) |