Name

remove, eventstore.remove, kPMRPCEventStoreRemove — Remove an event.

Synopsis

void eventstore.remove( unique ID);
unique ID : string, length 1..255;

Description

Remove an event.

remove removes an event from the Scheduler's events. Any performing instances of the event are stopped.

If the provided unique ID does not match an existing event's unique ID, events is not affected.

Parameters

unique ID. Unique ID of an event. unique ID is a string. unique ID must be between 1 and 255 characters long, inclusive.

Security

remove can be requested by any authenticated client.

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

Availablility

pmdctl

Examples

Example 57. C: Minimal eventstore.remove

CFStringRef myUniqueID = NULL;

...
CFMutableDictionaryRef myRequest = PMRequestCreateWithParameters(kCFAllocatorDefault, kPMRPCEventStoreRemove, kPMRPCParameterUniqueID, myUniqueID, nil);