GH_Component.GH_InputParamManager.AddArcParameter Method (String, String, String, GH_ParamAccess)

GH_ComponentGH_InputParamManagerAddArcParameter Method (String, String, String, GH_ParamAccess)

Add a 3D Arc parameter to the input list of this component.

Namespace:  Grasshopper.Kernel
Assembly:  Grasshopper (in Grasshopper.dll)
Syntax
Copy
public int AddArcParameter(
	string name,
	string nickname,
	string description,
	GH_ParamAccess access
)
Public Function AddArcParameter ( 
	name As String,
	nickname As String,
	description As String,
	access As GH_ParamAccess
) As Integer

Parameters

name
Type: SystemString
The name of the parameter. Keep it short, single words are best.
nickname
Type: SystemString
The nickname of the parameter. Keep it short, single characters are best.
description
Type: SystemString
The description of the parameter. Be succinct but clear, single sentences are best.
access
Type: Grasshopper.KernelGH_ParamAccess
Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively.

Return Value

Type: Int32
See Also

M:Grasshopper.Kernel.GH_Component.GH_InputParamManager.AddArcParameter(System.String,System.String,System.String,Grasshopper.Kernel.GH_ParamAccess)