Name

reset, scheduler.reset, kPMRPCSchedulerReset — Reset a pending trigger.

Synopsis

void scheduler.reset( trigger ID);
trigger ID : string, default, length 1..255, optional;

Description

Reset a pending trigger.

reset removes any previous cancel or adjust requests applied to the pending trigger.

Resetting a previously cancelled repeating trigger will cause the trigger to immediately calculate the next trigger date. The date and time calculated will be relative to now, rather than when the cancel request was received.

If the provided trigger ID does not match an existing queued trigger ID, no change occurs.

If no trigger ID is provided, all modifications are reset and the associated triggers are requeued.

Parameters

trigger ID. Trigger ID of a queued trigger. trigger ID is a string. If trigger ID is omitted, a default is created. trigger ID is optional. trigger ID must be between 1 and 255 characters long, inclusive.

Security

reset can be requested by any authenticated client.

Unauthenticated clients are authorized using the uk.co.dssw.powermanager.scheduler.reset right. By default, only local processes belonging to administrator can send a reset request.

Availablility

pmdctl

Examples

Example 126. C: Minimal scheduler.reset

CFMutableDictionaryRef myRequest = PMRequestCreate(kCFAllocatorDefault, kPMRPCSchedulerReset);