projects / apple / xnu.git / blame
| Commit | Line | Data |
|---|---|---|
| 13fec989 A |
1 | <h2>mach_port_set_attributes</h2> |
| 2 | <hr> | |
| 3 | <p> | |
| 4 | <strong>Function</strong> - Set the target port's attributes. | |
| 5 | <h3>SYNOPSIS</h3> | |
| 6 | <pre> | |
| 7 | <strong>kern_return_t mach_port_set_attributes</strong> | |
| 8 | <strong>(ipc_space_t</strong> <var>task</var>, | |
| 9 | <strong>mach_port_name_t</strong> <var>name</var>, | |
| 10 | <strong>mach_port_flavor_t</strong> <var>flavor</var>, | |
| 11 | <strong>mach_port_info_t</strong> <var>port_info</var>, | |
| 12 | <strong>mach_msg_type_number_t</strong> <var>port_info_count</var><strong>);</strong> | |
| 13 | </pre> | |
| 14 | <h3>PARAMETERS</h3> | |
| 15 | <dl> | |
| 16 | <p> | |
| 17 | <dt> <var>task</var> | |
| 18 | <dd> | |
| 19 | [in task send right] | |
| 20 | The task holding a receive right to the port in | |
| 21 | question. | |
| 22 | <p> | |
| 23 | <dt> <var>name</var> | |
| 24 | <dd> | |
| 25 | [in scalar] | |
| 26 | <var>task</var>'s name for the port. | |
| 27 | <p> | |
| 28 | <dt> <var>flavor</var> | |
| 29 | <dd> | |
| 30 | [in scalar] | |
| 31 | The type of attributes to be set. Valid values are: | |
| 32 | <dl> | |
| 33 | <p> | |
| 34 | <dt> <strong>MACH_PORT_LIMITS_INFO</strong> | |
| 35 | <dd> | |
| 36 | Sets resource limits (queue limits) for the port. The declaration | |
| 37 | of this data is found in structure <strong>mach_port_limits</strong>. | |
| 38 | </dl> | |
| 39 | <p> | |
| 40 | <dt> <var>port_info</var> | |
| 41 | <dd> | |
| 42 | [pointer to in structure] | |
| 43 | Attributes for the specified port. | |
| 44 | <p> | |
| 45 | <dt> <var>port_info_count</var> | |
| 46 | <dd> | |
| 47 | [in scalar] | |
| 48 | The size of the buffer (in natural-sized units). | |
| 49 | </dl> | |
| 50 | </dl> | |
| 51 | <h3>DESCRIPTION</h3> | |
| 52 | <p> | |
| 53 | The <strong>mach_port_set_attributes</strong> function sets attributes of type | |
| 54 | <var>flavor</var>. | |
| 55 | <h3>NOTES</h3> | |
| 56 | <p> | |
| 57 | This interface is machine word length specific because of the port name | |
| 58 | parameter. | |
| 59 | <h3>RETURN VALUES</h3> | |
| 60 | <dl> | |
| 61 | <p> | |
| 62 | <dt> <strong>KERN_INVALID_NAME</strong> | |
| 63 | <dd> | |
| 64 | <var>name</var> did not denote a right. | |
| 65 | <p> | |
| 66 | <dt> <strong>KERN_INVALID_RIGHT</strong> | |
| 67 | <dd> | |
| 68 | <var>name</var> denoted a right, but not a receive right. | |
| 69 | </dl> | |
| 70 | <h3>RELATED INFORMATION</h3> | |
| 71 | <p> | |
| 72 | Functions: | |
| 73 | <a href="mach_port_allocate.html"><strong>mach_port_allocate</strong></a>, | |
| 74 | <a href="mach_port_allocate_name.html"><strong>mach_port_allocate_name</strong></a>, | |
| 75 | <a href="mach_port_get_attributes.html"><strong>mach_port_get_attributes</strong></a>. | |
| 76 | <p> | |
| 77 | Data Structures: | |
| 78 | <a href="mach_port_limits.html"><strong>mach_port_limits</strong></a>. |