Name

sample execute external, sampleexecuteexternal, kPMSampleSampleExecuteExternal — Sample from an external executable.

Synopsis

sample execute external structure { initial delay, frequency, window, limit, criteria, source, external, external criterion };
initial delay : integer, default, optional, range 0..n
frequency : integer, default, optional, range 0..n
window : integer, default, optional, range 1..n
limit : integer, optional, range 1..n
criteria : array of sample criterion structures, length 1..n, optional, unique
source : string, choice, default
external : external structure
external criterion : external criterion structure, optional

Description

Sample from an external executable.

Fields

initial delay. Delay before sampling begins in seconds.

initial delay is an integer. If initial delay is omitted, the default 0 is used. initial delay is optional. initial delay must be more than or equal to 0.

frequency. Frequency of sampling in seconds.

frequency is an integer. If frequency is omitted, the default 30 is used. frequency is optional. frequency must be more than or equal to 0.

window. Sample window to evaluate.

The number of historic samples to use when determining if the criteria has been met. The window represents a collection of the latest samples gathered. As samples leave the window they are released and will not be used in any future evaluations.

No evaluation will occur until enough samples have been collected to fill the window.

window is an integer. If window is omitted, the default 1 is used. window is optional. window must be more than or equal to 1.

limit. Seconds after sampling begins that it is stopped.

If the sampling has not reached a result and limit's duration has passed since sampling begun, stop the sampling. Limit provides a time constraint on the sampling process.

limit is an integer. limit is optional. limit must be more than or equal to 1.

criteria. Criteria to evaluate gathered samples with.

criteria is an array of sample criterion structures. criteria is optional. criteria must be 1 items or more. Each item in criteria must be unique.

source. Source of samples.

source is a string. If source is omitted, the default execute external is used. source must be execute external, kPMSampleSource_ExecuteExternal.

external. external to launch.

Details of the external executable to launch.

external is a external structure.

external criterion. Criterion to judge external executable by on exit.

external criterion is a external criterion structure. external criterion is optional.