v2.34
 
IParameter Interface Reference

Represents a parameter. Parameter contains the value of one of the following types: length or angle. This interface can be obtained through IParameterContainer. More...

Inheritance diagram for IParameter:

Public Member Functions

HRESULT GetBoolValue ([out, retval] VARIANT_BOOL *pValue)
 Returns the parameter value as bool value.
 
HRESULT GetDoubleValue ([out, retval] double *pValue)
 Returns the parameter value as a double value.
 
HRESULT GetIntValue ([out, retval] int *pValue)
 Returns the parameter value as an integer value.
 
HRESULT GetStringValue ([out, retval] BSTR *pValue)
 Returns the parameter value as a string value.
 
HRESULT HasValue ([out, retval] VARIANT_BOOL *pValue)
 Indicates if the parameter has a value.
 
HRESULT SetBoolValue ([in] VARIANT_BOOL value)
 Sets the parameter value.
 
HRESULT SetDoubleValue ([in] double value)
 Sets the parameter value.
 
HRESULT SetIntValue ([in] int value)
 Sets the parameter value.
 
HRESULT SetStringValue ([in] BSTR value)
 Sets the parameter value.
 

Properties

IParameterDefinition Definition [get]
 The definition of the parameter.
 
GUID Id [get]
 The unique identifier of the parameter.
 
BSTR IdS [get]
 Same as Id, but accepting GUID as a string.
 
ParameterValueType ValueType [get]
 The value type of the parameter.
 

Detailed Description

Represents a parameter. Parameter contains the value of one of the following types: length or angle. This interface can be obtained through IParameterContainer.

Member Function Documentation

◆ GetBoolValue()

HRESULT GetBoolValue ( [out, retval] VARIANT_BOOL * pValue)

Returns the parameter value as bool value.

Parameters
[out]pValueThe parameter's value.

◆ GetDoubleValue()

HRESULT GetDoubleValue ( [out, retval] double * pValue)

Returns the parameter value as a double value.

Parameters
[out]pValueThe parameter's value.

◆ GetIntValue()

HRESULT GetIntValue ( [out, retval] int * pValue)

Returns the parameter value as an integer value.

Parameters
[out]pValueThe parameter's value.

◆ GetStringValue()

HRESULT GetStringValue ( [out, retval] BSTR * pValue)

Returns the parameter value as a string value.

Parameters
[out]pValueThe parameter's value.

◆ HasValue()

HRESULT HasValue ( [out, retval] VARIANT_BOOL * pValue)

Indicates if the parameter has a value.

Returns
TRUE if the parameter has a value; otherwise returns FALSE.

Property Documentation

◆ Definition

IParameterDefinition Definition
get

The definition of the parameter.

Returns
The definition of the parameter.

◆ Id

GUID Id
get

The unique identifier of the parameter.

Returns
The unique identifier of the parameter.

◆ ValueType

ParameterValueType ValueType
get

The value type of the parameter.

Returns
The value type of the parameter.