CLC_ErrorCode Input_AddTextParameter	(	CPHOBJECT const	hInput,
		CPCHAR8 const *const	utf8Name,
		CPUINT16 const	wMsgNum,
		CPHOBJECT const	hIndexList,
		CPUINT16 const	wGroup,
		TextInformationProfiles const	informationProfiles,
		ControllerTypes const	preferredControllerType,
		CPUINT32 const	dwParameterUserData,
		CPHOBJECT *const	phParameter
	)

Add a Text parameter.

Note

Don't forget to set the CPNS::Enums::IOC_Explorable capability to the owner input in order to allow parameters exploration and remote control.

Parameters

[in]	hInput	Input handle
[in]	utf8Name	the parameter's name
[in]	wMsgNum	message number (see CPNS::Enums::Modifiers)
[in]	hIndexList	handle of the related Index List, or CPHOBJECT_NULL if the parameter is not indexed.
[in]	wGroup	the parameter's group. Parameters having the same group number (>0) are physically attached.
[in]	informationProfiles	combination of optional information profiles. See::TextInformationProfiles
[in]	preferredControllerType	the preferred controller type for this parameter, without the CT_Msg* part. See ControllerTypes
[in]	dwParameterUserData	A 32 bit user data associated to the returned parameter handle. This data will be passed back to the application in parameter notifications.
[out]	phParameter	Pointer to the handle of the new parameter, or CPHOBJECT_NULL in case of error

Returns

Standard CHAILink Client return code. See CLC_ErrorCode enumeration.

Warning

This function can only be called in CopperLan context. This means in the pseudo task CPDoProcess(), in notification handlers or in asynchronous return handlers and not in SystemDoProcess() for instance.