Classes
struct	Ext_locks
	Extended lock controls. More...

struct	Ext_locks2
	Extended lock controls. More...

struct	MlineTcbFlags
	These settings affecting the placement and operation of multi-lines are stored in the TCB. More...

Functions
static BentleyStatus	GetValue (bool &value, ActiveBoolParams paramName)
	Gets the value of an active MicroStation setting of type boolean. More...

static BentleyStatus	GetValue (UInt32 &value, ActiveUInt32Params paramName)
	Gets the value of an active MicroStation setting of type unsigned integer. More...

static BentleyStatus	GetValue (Int32 &value, ActiveInt32Params paramName)
	Gets the value of an active MicroStation setting of type signed integer. More...

static BentleyStatus	GetValue (double &value, ActiveDoubleParams paramName)
	Gets the value of an active MicroStation setting of type double precision floating point. More...

static BentleyStatus	GetValue (DPoint3dR value, ActiveDPoint3dParams paramName)
	Gets the value of an active MicroStation setting of type DPoint3d. More...

static BentleyStatus	GetValue (WStringR value, ActiveStringParams paramName)
	Gets the value of an active MicroStation setting of type string. More...

static BentleyStatus	GetValue (LineStyleParamsR value, ActiveLineStyleParams paramName)
	Gets the value of an active MicroStation setting of type string. More...

static BentleyStatus	GetValue (GradientSymbR value, ActiveGradientFillParams paramName)
	Gets the active MicroStation gradient fill settings. More...

static BentleyStatus	SetValue (bool value, ActiveBoolParams paramName)
	Sets the value of an active MicroStation setting of type boolean. More...

static BentleyStatus	SetValue (UInt32 value, ActiveUInt32Params paramName)
	Sets the value of an active MicroStation setting of type unsigned integer. More...

static BentleyStatus	SetValue (Int32 value, ActiveInt32Params paramName)
	Sets the value of an active MicroStation setting of type signed integer. More...

static BentleyStatus	SetValue (double value, ActiveDoubleParams paramName)
	Sets the value of an active MicroStation setting of type double. More...

static BentleyStatus	SetValue (DPoint3dCR value, ActiveDPoint3dParams paramName)
	Sets the value of an active MicroStation setting of type DPoint3d. More...

static BentleyStatus	SetValue (WCharCP value, ActiveStringParams paramName)
	Sets the value of an active MicroStation setting of type string. More...

static BentleyStatus	SetValue (LineStyleParamsCR value, ActiveLineStyleParams paramName)
	Sets the value of an active MicroStation setting of type string. More...

static BentleyStatus	SetValue (GradientSymbCR value, ActiveGradientFillParams paramName)
	Sets the active MicroStation gradient fill settings. More...

int	mdlParams_getLock (int paramName)
	Gets the state of one of MicroStation's locks. More...

int	mdlParams_setLock (int lockVal, int paramName)
	Sets the state of one of MicroStation's locks. More...

Detailed Description

Function Documentation

static BentleyStatus GetValue	(	bool &	value,
		ActiveBoolParams	paramName
	)

static

Gets the value of an active MicroStation setting of type boolean.

Parameters

[out]	value	points to a buffer to receive the current value of the specified setting
[in]	paramName	specifies which setting to retrieve.

Returns: SUCCESS if the active parameter value is returned in value, or ERROR if paramName is not valid.

See also: ActiveParams::SetBool

static BentleyStatus GetValue	(	UInt32 &	value,
		ActiveUInt32Params	paramName
	)

static

Gets the value of an active MicroStation setting of type unsigned integer.

Parameters

[out]	value	points to a buffer to receive the current value of the specified setting
[in]	paramName	specifies which setting to retrieve.

Returns: SUCCESS if the active parameter value is returned in value, or ERROR if paramName is not valid.

See also: ActiveParams::SetUInt32

static BentleyStatus GetValue	(	Int32 &	value,
		ActiveInt32Params	paramName
	)

static

Gets the value of an active MicroStation setting of type signed integer.

Parameters

[out]	value	points to a buffer to receive the current value of the specified setting
[in]	paramName	specifies which setting to retrieve.

Returns: SUCCESS if the active parameter value is returned in value, or ERROR if paramName is not valid.

See also: ActiveParams::SetInt32

static BentleyStatus GetValue	(	double &	value,
		ActiveDoubleParams	paramName
	)

static

Gets the value of an active MicroStation setting of type double precision floating point.

Parameters

[out]	value	points to a buffer to receive the current value of the specified setting
[in]	paramName	specifies which setting to retrieve.

Returns: SUCCESS if the active parameter value is returned in value, or ERROR if paramName is not valid.

See also: ActiveParams::SetDouble

static BentleyStatus GetValue	(	DPoint3dR	value,
		ActiveDPoint3dParams	paramName
	)

static

Gets the value of an active MicroStation setting of type DPoint3d.

Parameters

[out]	value	points to a buffer to receive the current value of the specified setting
[in]	paramName	specifies which setting to retrieve.

Returns: SUCCESS if the active parameter value is returned in value, or ERROR if paramName is not valid.

See also: ActiveParams::SetDPoint3d

static BentleyStatus GetValue	(	WStringR	value,
		ActiveStringParams	paramName
	)

static

Gets the value of an active MicroStation setting of type string.

Parameters

[out]	value	points to a buffer to receive the current value of the specified setting
[in]	paramName	specifies which setting to retrieve.

Returns: SUCCESS if the active parameter value is returned in value, or ERROR if paramName is not valid.

See also: ActiveParams::SetString

static BentleyStatus GetValue	(	LineStyleParamsR	value,
		ActiveLineStyleParams	paramName
	)

static

Gets the value of an active MicroStation setting of type string.

Parameters

[out]	value	points to a buffer to receive the current value of the specified setting
[in]	paramName	specifies which setting to retrieve.

Returns: SUCCESS if the active parameter value is returned in value, or ERROR if paramName is not valid.

See also: ActiveParams::SetString

static BentleyStatus GetValue	(	GradientSymbR	value,
		ActiveGradientFillParams	paramName
	)

static

Gets the active MicroStation gradient fill settings.

Parameters

[out]	value	To receive the current settings.
[in]	paramName	specifies which setting to retrieve.

Returns: SUCCESS if the active settings are returned in value, or ERROR if paramName is not valid.

See also: ActiveParams::SetString

int mdlParams_getLock ( int paramName )

Gets the state of one of MicroStation's locks.

Parameters

[in] paramName the lock to retrieve the value of. This should be one of the ACTIVELOCK_ constant values listed in mdl.h.

Returns: the current state of the lock if paramName is one of the valid constants, or ERROR otherwise.

See also: mdlParams_setLock

int mdlParams_setLock	(	int	lockVal,
		int	paramName
	)

Sets the state of one of MicroStation's locks.

Parameters

[in]	lockVal	the value to set for the lock, either 0 or 1.
[in]	paramName	the name of the lock to set the value of. This should be one of the ACTIVELOCK_ constant values listed in mdl.h.

Returns: ERROR if the paramName is not one of the above constants or lockVal is not 0 or 1, SUCCESS otherwise.

See also: mdlParams_getLock

static BentleyStatus SetValue	(	bool	value,
		ActiveBoolParams	paramName
	)

static

Sets the value of an active MicroStation setting of type boolean.

Parameters

[in]	value	the new value for the specified setting.
[in]	paramName	specifies which setting to retrieve.

Returns: SUCCESS if the active parameter value is set, or ERROR if either paramName is not valid or if the setting is readonly and thus can't be changed.

See also: ActiveParams::GetBool

Remarks: Required Library: mdlbltin.lib +------------—+------------—+------------—+------------—+------------—+---—

static BentleyStatus SetValue	(	UInt32	value,
		ActiveUInt32Params	paramName
	)

static

Sets the value of an active MicroStation setting of type unsigned integer.

Parameters

[in]	value	the new value for the specified setting.
[in]	paramName	specifies which setting to retrieve.

Returns: SUCCESS if the active parameter value is set, or ERROR if either paramName is not valid or if the setting is readonly and thus can't be changed.

See also: ActiveParams::GetUInt32

Remarks: Required Library: mdlbltin.lib +------------—+------------—+------------—+------------—+------------—+---—

static BentleyStatus SetValue	(	Int32	value,
		ActiveInt32Params	paramName
	)

static

Sets the value of an active MicroStation setting of type signed integer.

Parameters

[in]	value	the new value for the specified setting.
[in]	paramName	specifies which setting to retrieve.

Returns: SUCCESS if the active parameter value is set, or ERROR if either paramName is not valid or if the setting is readonly and thus can't be changed.

See also: ActiveParams::GetInt32

Remarks: Required Library: mdlbltin.lib +------------—+------------—+------------—+------------—+------------—+---—

static BentleyStatus SetValue	(	double	value,
		ActiveDoubleParams	paramName
	)

static

Sets the value of an active MicroStation setting of type double.

Parameters

[in]	value	the new value for the specified setting.
[in]	paramName	specifies which setting to retrieve.

Returns: SUCCESS if the active parameter value is set, or ERROR if either paramName is not valid or if the setting is readonly and thus can't be changed.

See also: ActiveParams::GetDouble

Remarks: Required Library: mdlbltin.lib +------------—+------------—+------------—+------------—+------------—+---—

static BentleyStatus SetValue	(	DPoint3dCR	value,
		ActiveDPoint3dParams	paramName
	)

static

Sets the value of an active MicroStation setting of type DPoint3d.

Parameters

[in]	value	the new value for the specified setting.
[in]	paramName	specifies which setting to retrieve.

Returns: SUCCESS if the active parameter value is set, or ERROR if either paramName is not valid or if the setting is readonly and thus can't be changed.

See also: ActiveParams::GetDPoint3d

Remarks: Required Library: mdlbltin.lib +------------—+------------—+------------—+------------—+------------—+---—

static BentleyStatus SetValue	(	WCharCP	value,
		ActiveStringParams	paramName
	)

static

Sets the value of an active MicroStation setting of type string.

Parameters

[in]	value	the new value for the specified setting.
[in]	paramName	specifies which setting to retrieve.

Returns: SUCCESS if the active parameter value is set, or ERROR if either paramName is not valid or if the setting is readonly and thus can't be changed.

See also: ActiveParams::GetString

Remarks: Required Library: mdlbltin.lib +------------—+------------—+------------—+------------—+------------—+---—

static BentleyStatus SetValue	(	LineStyleParamsCR	value,
		ActiveLineStyleParams	paramName
	)

static

Sets the value of an active MicroStation setting of type string.

Parameters

[in]	value	the new value for the specified setting.
[in]	paramName	specifies which setting to retrieve.

Returns: SUCCESS if the active parameter value is set, or ERROR if either paramName is not valid or if the setting is readonly and thus can't be changed.

See also: ActiveParams::GetString

Remarks: Required Library: mdlbltin.lib +------------—+------------—+------------—+------------—+------------—+---—

static BentleyStatus SetValue	(	GradientSymbCR	value,
		ActiveGradientFillParams	paramName
	)

static

Sets the active MicroStation gradient fill settings.

Parameters

[in]	value	the new settiings for the specified setting.
[in]	paramName	specifies which setting to retrieve.

Returns: SUCCESS if the active parameter value is set, or ERROR if either paramName is not valid or if the setting is readonly and thus can't be changed.

See also: ActiveParams::GetString

Remarks: Required Library: mdlbltin.lib +------------—+------------—+------------—+------------—+------------—+---—

Classes

Functions

Detailed Description

Function Documentation