KCML_PerfMetric_Clear

Purpose

Stop a performance metric.

Definition

DEFSUB 'KCML_PerfMetric_Clear(nMetric, nPartition, sToken$ = "") AS KCML_PERFMETRIC_STATUS_ENUM

Parameters

nMetric	Performance metric flag value.
nPartition	Partition number or 0 for all sessions.
sToken	Optional. Security token with a SHA-256 signature.

Return

Returns a KCML_PERFMETRIC_STATUS_ENUM value.

Description

Clear the flag to stop the collection of the specified performance metric. Requires an extended $PSTAT to be configured. The security token, sToken$, is only required when clearing a metric for all partitions, ie when nPartition is 0. See Performance Metrics: Access Control for more information on the security token parameter, sToken$.

See also

Internal KCML Functions, Internally defined structures and Internally defined enumerations and constants.