CIP C++ documentation for class "pfcUDFVariantPatternParam"

Class pfcUDFVariantPatternParam

# include <pfcUDFCreate.h> class pfcUDFVariantPatternParam : public virtual pfcUDFVariantValue { xdeclare(pfcUDFVariantPatternParam) ... }; This is a COMPACT class.

Description

This class specifies the name of the pattern parameter the user must supply to place the UDF.

Manual References:: Features: Creating a Custom UDF

Method Summary


`static pfcUDFVariantPatternParam_ptr`	`Create (xrstring Name, xint PatternParam)`
	Specifies the name of the pattern parameter the user must supply to place the UDF.

`xint`	`GetPatternParam ()`
`void`	`SetPatternParam (xint value)`
	The parameter name

Methods Inherited from Class pfcUDFVariantValue:: GetType, GetName, SetName

Method Detail

`xint`	`GetPatternParam`	`()`
`void`	`SetPatternParam`	`(xint value)`

The parameter name

static pfcUDFVariantPatternParam_ptr Create (xrstring Name, xint PatternParam)

Specifies the name of the pattern parameter the user must supply to place the UDF.

Used as a component of pfcUDFCustomCreateInstructions .

Manual References:: Features: Creating a Custom UDF, Features: Creating a Custom UDF

Parameters:

Name: The name given to the pattern parameter by the UDF.
PatternParam: The parameter value

Returns:: Instance of the UDFVariantPatternParem object.