FSEventStreamCreateOptions Class

Definition

Namespace:

CoreServices

Assembly:

Microsoft.macOS.dll

Creation options for FSEventStream.

public sealed class FSEventStreamCreateOptions

type FSEventStreamCreateOptions = class

Inheritance

Object

FSEventStreamCreateOptions

Constructors

Name	Description
FSEventStreamCreateOptions()
FSEventStreamCreateOptions(FSEventStreamCreateFlags, TimeSpan, String[])
FSEventStreamCreateOptions(FSEventStreamCreateFlags, TimeSpan, UInt64, String[])

Properties

Name	Description
Allocator	The allocator to use to allocate memory for the stream. If null, the default allocator will be used.
DeviceToWatch	A dev_t corresponding to the device which you want to receive notifications from. The dev_t is the same as the st_dev field from a stat structure of a file on that device or the f_fsid[0] field of a statfs structure.
Flags	Flags that modify the behavior of the stream being created. See FSEventStreamCreateFlags.
Latency	The amount of time the service should wait after hearing about an event from the kernel before passing it along to the client via its callback. Specifying a larger value may result in more effective temporal coalescing, resulting in fewer callbacks.
PathsToWatch	A list of directory paths, signifying the root of a filesystem hierarchy to be watched for modifications. If DeviceToWatch is set, the list of paths should be relative to the root of the device. For example, if a volume "MyData" is mounted at "/Volumes/MyData" and you want to watch "/Volumes/MyData/Pictures/July", specify a path string of "Pictures/July". To watch the root of a volume pass a path of "" (the empty string).
SinceWhenId	The service will supply events that have happened after the given event ID. To ask for events "since now," set to null or SinceNowId. Often, clients will supply the highest-numbered event ID they have received in a callback, which they can obtain via LatestEventId. Do not set to zero, unless you want to receive events for every directory modified since "the beginning of time" -- an unlikely scenario.

Methods

Name	Description
CreateStream()