]> sigrok.org Git - libserialport.git/blame_incremental - config-pattern
Fix a potential segfault in sp_get_port_handle().
[libserialport.git] / config-pattern
... / ...
CommitLineData
1/**
2 * Set the {2} for the specified serial port.
3 *
4 * @param[in] port Pointer to a port structure. Must not be NULL.
5 * @param[in] {0} {3}.
6 *
7 * @return SP_OK upon success, a negative error code otherwise.
8 *
9 * @since 0.1.0
10 */
11enum sp_return sp_set_{0}(struct sp_port *port, {1} {0});
12
13/**
14 * Get the {2} from a port configuration.
15 *
16 * The user should allocate a variable of type {1} and
17 * pass a pointer to this to receive the result.
18 *
19 * @param[in] config Pointer to a configuration structure. Must not be NULL.
20 * @param[out] {0}_ptr Pointer to a variable to store the result. Must not be NULL.
21 *
22 * @return SP_OK upon success, a negative error code otherwise.
23 *
24 * @since 0.1.0
25 */
26enum sp_return sp_get_config_{0}(const struct sp_port_config *config, {1} *{0}_ptr);
27
28/**
29 * Set the {2} in a port configuration.
30 *
31 * @param[in] config Pointer to a configuration structure. Must not be NULL.
32 * @param[in] {0} {3}, or -1 to retain the current setting.
33 *
34 * @return SP_OK upon success, a negative error code otherwise.
35 *
36 * @since 0.1.0
37 */
38enum sp_return sp_set_config_{0}(struct sp_port_config *config, {1} {0});