X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/9bccf70c0258c7cac2dcb80011b2a964d884c552..39236c6e673c41db228275375ab7fdb0f837b292:/osfmk/man/mach_port_destroy.html diff --git a/osfmk/man/mach_port_destroy.html b/osfmk/man/mach_port_destroy.html old mode 100755 new mode 100644 index 4a0a4ba0e..3981aec69 --- a/osfmk/man/mach_port_destroy.html +++ b/osfmk/man/mach_port_destroy.html @@ -1 +1,71 @@ -
Function - Deallocate all port rights associated with specified name.
kern_return_t mach_port_destroy (ipc_space_t task, mach_port_name_t name);
The mach_port_destroy function de-allocates all rights denoted by a name. The name becomes immediately available for reuse.
For most purposes, mach_port_mod_refs and mach_port_deallocate are preferable.
If name denotes a port set, then all members of the port set are implicitly removed from the port set.
If name denotes a receive right that is a member of a port set, the receive right is implicitly removed from the port set. Remaining messages queued to the port are destroyed and extant send and send-once rights turn into dead names. If those send and send-once rights have dead-name requests registered, then dead-name notifications are generated for them.
If name denotes a send-once right, then the destruction of the send-once right produces a send-once notification for the port.
If name denotes a send-once, send, and/or receive right, and it has a dead-name request registered, then a port-deleted notification is generated (as opposed to a dead-name notification).
This interface is machine word length specific because of the port name parameter.
Functions: mach_port_allocate, mach_port_allocate_name, mach_port_mod_refs, mach_port_deallocate, mach_port_request_notification. \ No newline at end of file +
+Function - Deallocate all port rights associated with specified name. +
+kern_return_t mach_port_destroy + (ipc_space_t task, + mach_port_name_t name); ++
+
+
+The mach_port_destroy function de-allocates all rights +denoted by a name. +The name becomes immediately available for reuse. +
+For most purposes, +mach_port_mod_refs and mach_port_deallocate are +preferable. +
+If name denotes a port set, then all members of the port set are implicitly +removed from the port set. +
+If name denotes a receive right that is a member of a port set, +the receive right is +implicitly removed from the port set. Remaining messages queued to the port +are destroyed and extant send and send-once rights turn into dead names. If +those send and send-once rights have dead-name requests registered, then +dead-name notifications are generated for them. +
+If name denotes a send-once right, then +the destruction of the send-once right +produces a send-once notification for the port. +
+If name denotes a send-once, send, and/or receive right, and +it has a dead-name +request registered, then a port-deleted notification is generated +(as opposed to a +dead-name notification). +
+This interface is machine word length specific because of the port name +parameter. +
+
+Functions: +mach_port_allocate, +mach_port_allocate_name, +mach_port_mod_refs, +mach_port_deallocate, +mach_port_request_notification.