SPCSubgroupSizeGet

Gets the subgroup size for the specified SPC tag. The value that is returned is the value that is currently being used by the SPC (trend) server, not necessarily the value specified in the SPC Tag definition.

This function is a blocking function. It will block the calling Cicode task until the operation is complete.

This function can only be called while the SPC tag is being displayed on an SPC page.

Syntax

SPCSubgroupSizeGet(sSPCTag, SizeVariable [, sClusterName] )

sSPCTag:

The SPC Tag name as defined in SPC Tags.

SizeVariable:

The Cicode variable that stores the subgroup size. This variable needs to be defined as a global of type INT. A constant is not allowed. Must be a Long type variable.

sClusterName:

Specifies the name of the cluster of the SPC tag.

Return Value

0 (zero) if successful, otherwise an error number is returned. The subgroup size is written to SizeVariable.

Related Functions

SPCClientInfo, SPCSubgroupSizeSet

Example

See SPCSubgroupSizeSet.

See Also

SPC Functions