## clock_map_time

Function - Return a memory object that maps a clock.

### SYNOPSIS

    kern_return_t   clock_map_time
                    (clock_t                             clock_name,
                     memory_object_t                   clock_memory);

### PARAMETERS

clock_name
  [in clock-name send right] The name (or control) port for the clock.

clock_memory
  [out memory-object-representative send right] Mapped clock time memory object representative.

### DESCRIPTION

The clock_map_time function returns a memory object representative port representing read access to a memory object that contains (at offset zero) a mapped version of the clock time (structure mapped_tvalspec). The returned right is suitable as an argument for vm_map.

### NOTES

Not all clocks provide this service, but the REALTIME clock must.

### RETURN VALUES

KERN_FAILURE
  The specified clock does not provide this service.

### RELATED INFORMATION

Functions: host_get_clock_service, clock_get_attributes, clock_get_time, clock_sleep, clock_alarm.

Data Structures: mapped_tvalspec.