KernelCAD Documentation

DInsight Home
Skip Navigation Links.
Start page
Quick Start
Installation
Overview of the software
What is new
Expand KernelCAD ModelsKernelCAD Models
Collapse KernelCAD ComponentsKernelCAD Components
KernelCAD Control
KernelCAD .NET Control
Methods and Properties
Menu
Model Explorer
Birds Eye View
Programming
Direct User Access
Direct Operations
Interface Queries
Printing Support
Data Types
Modes of KernelCAD Control
DIObjectGenerator class
Properties
FlatObjectArray Poperty
Context
64 bit development
Dual Mode
Initialisation Context
Overlay Editor
Memory Management
Input validation
Expand Advanced functionalityAdvanced functionality
Collapse InterfacesInterfaces
Alphabetical list
I3DGrid
I3DBugger
I3Dpt
IAxiBase
IAxis
IBoolSection
IBoolSectionEx
IBoundary
IColor
IConstraint
IData
IDiffSurface_KC
IDIFont
IDraw
IDrawUtil
IDraw2
IElem
IElement
IKCLine
ILightSource
ILocation
ILocationEx
IMaterial
IMetrics
IMetrics2
IModel
IModel2
IModelEx
IPatch
IKCPathCollisionDetector
IProfiles
IPropertyArray
IPropertyArray2
IStdShape
IStrip
ISurface
IText
ITexture
ITransform
IUnknown
Expand Open Cascade TechnologyOpen Cascade Technology
Expand DataData
Expand MovementMovement
Expand FramesFrames
Expand Oriented ObjectsOriented Objects
Expand SectionsSections
Collapse GeneralGeneral
Expand Container InterfacesContainer Interfaces
IObject_KC
ITypeBasic_KC2
IModelSearch_KC
IBitmap
IBlob
IKCContext
IKCContext2
IError_KC
IKCStack
ILineStyle_KC
IMenu_KC
IMenuItem_KC
IGlobalAPI_KC
IControlInitialisationContext_KC
IRange
IRectangleAxisAligned_KC
ITechnology_DG
Expand Topological InterfacesTopological Interfaces
Expand Viewing InterfacesViewing Interfaces
Expand Lines And CurvesLines And Curves
Expand Symmetry InterfacesSymmetry Interfaces
Expand Clipping plane interfacesClipping plane interfaces
Expand AlgorithmsAlgorithms
Expand 2D Geometry2D Geometry
Expand Programming Samples and TutorialsProgramming Samples and Tutorials
Expand 3D Debugger3D Debugger
Expand DeploymentDeployment
Licensing
Model Viewer
Open C++ Source
Technical Support
Skip Navigation LinksHome Page > KernelCAD Components > Interfaces > General > IKCContext
IKCContext Interface

IKCContext Interface

GetParamCount
SetIntParam
GetDoubleParam
SetDoubleParam
GetBoolParam
SetBoolParam
GetStringParam
SetStringParam
GetParam
SetParam

Manages parameters of a context. Contexts are data structures used to store or pass parameters to methods where usage of normal method parameters is difficult or not possible. An example is the State of 3DBugger

Context of a 2DView can be acquired with a call to I2DView_KC.GetContext.

See also: IKCContext2Interface List


HRESULT GetParamCount(int type, int* count)

Parameters

type - [in] Type of parameter. Valid options are enumerated in EKCType

count - [out, retval] the returned count

Remarks:

If type parameter is set to eKCTypeNULL total count of parameters of all types in the context is returned.


HRESULT GetIntParam(int id, int *val)

Parameters

id - [in] 0-based index in array of integer parameters of the context

val - [out, retval] The returned value of the parameter

Remarks:

Returns id-th integer parameters in the context. The method fails if id is greater or equal to count retuned by GetParamCount(EKCType.eKCTypeLong, count)


HRESULT SetIntParam(int id, int val)

Parameters

id - [in] 0-based index in array of integer parameters of the context

val - [in] new value of the parameter

Remarks:

Modifies id-th integer parameters in the context. The method fails if id is greater or equal to count retuned by GetParamCount(EKCType.eKCTypeLong, count)


HRESULT GetDoubleParam(int id, double *val)

Parameters

id - [in] 0-based index in array of double parameters of the context

val - [out, retval] The returned value of the parameter

Remarks:

Returns id-th idouble parameters in the context. The method fails if id is greater or equal to count retuned by GetParamCount(EKCType.eKCTypeDouble, count)


HRESULT SetDoubleParam(int id, double val)

Parameters

id - [in] 0-based index in array of double parameters of the context

val - [in] new value of the parameter

Remarks:

Modifies id-th idouble parameters in the context. The method fails if id is greater or equal to count retuned by GetParamCount(EKCType.eKCTypeDouble, count).


HRESULT GetBoolParam(int id, VARIANT_BOOL *val)

Parameters

id - [in] 0-based index in array of Boolean parameters of the context

val - [out, retval] The returned value of the parameter

Remarks:

Returns id-th Boolean parameters in the context. The method fails if id is greater or equal to count retuned by GetParamCount(EKCType.eKCTypeBool, count)


HRESULT SetBoolParam(int id, VARIANT_BOOL val)

Parameters

id - [in] 0-based index in array of Boolean parameters of the context

val - [out, retval] The returned value of the parameter

Remarks:

Modifies id-th Boolean parameters in the context. The method fails if id is greater or equal to count retuned by GetParamCount(EKCType.eKCTypeBool, count).


HRESULT GetStringParam(int id, BSTR *val)

Parameters

id - [in] 0-based index in array of string parameters of the context

val - [out, retval] The returned value of the parameter

Remarks:

Returns id-th string parameters in the context. The method fails if id is greater or equal to count retuned by GetParamCount(EKCType.eKCTypeString, count)


HRESULT SetStringParam(int id, char *val)

Parameters

id - [in] 0-based index in array of string parameters of the context

val - [in] new value of the parameter

Remarks:

Modifies id-th string parameters in the context. The method fails if id is greater or equal to count retuned by GetParamCount(EKCType.eKCTypeString, count)


HRESULT GetParam(int id, VARIANT *param)

Parameters

id - [in] 0-based index in array of all parameters of the context

param- [out, retval] The returned value of the parameter

Remarks:

Returns id-th parameters in the context. The method fails if id is greater or equal to count retuned by GetParamCount(EKCType.eKCTypeNULL, count)


HRESULT SetParam(int id, VARIANT *param)

Parameters

id - [in] 0-based index in array of all parameters of the context

param - [in] new value of the parameter

Remarks:

Modifies id-th parameters in the context. The method fails if id is greater or equal to count retuned by GetParamCount(EKCType.eKCTypeNULL, count)