Class FunctionOutputParameterDefinitionExtensions

Function output parameter extensions, for fluent building of output parameters

Inheritance

System.Object

FunctionOutputParameterDefinitionExtensions

Namespace: MESL.SqlRace.Domain.Functions

Assembly: MESL.SqlRace.Domain.dll

Syntax

public static class FunctionOutputParameterDefinitionExtensions : Object

Methods

ApplicationName(FunctionOutputParameterDefinition, String)

Sets ApplicationName

Declaration

public static FunctionOutputParameterDefinition ApplicationName(this FunctionOutputParameterDefinition self, string applicationName)

Parameters

Type	Name	Description
FunctionOutputParameterDefinition	self	The FunctionOutputParameter instance.
System.String	applicationName	The application group for this parameter

Returns

Type	Description
FunctionOutputParameterDefinition	The FunctionOutputParameterDefinition.

BitShift(FunctionOutputParameterDefinition, Int16)

Sets BitShift

Declaration

public static FunctionOutputParameterDefinition BitShift(this FunctionOutputParameterDefinition self, short bitShift)

Parameters

Type	Name	Description
FunctionOutputParameterDefinition	self	The FunctionOutputParameter instance.
System.Int16	bitShift	Bit shift for this parameter

Returns

Type	Description
FunctionOutputParameterDefinition	The FunctionOutputParameterDefinition.

ByteOrder(FunctionOutputParameterDefinition, ByteOrderType)

Sets ByteOrder

Declaration

public static FunctionOutputParameterDefinition ByteOrder(this FunctionOutputParameterDefinition self, ByteOrderType byteOrder)

Parameters

Type	Name	Description
FunctionOutputParameterDefinition	self	The FunctionOutputParameter instance.
ByteOrderType	byteOrder	The endianness of this parameter

Returns

Type	Description
FunctionOutputParameterDefinition	The FunctionOutputParameterDefinition.

ConversionFunctionName(FunctionOutputParameterDefinition, String)

Sets ConversionFunctionName

Declaration

public static FunctionOutputParameterDefinition ConversionFunctionName(this FunctionOutputParameterDefinition self, string conversionFunctionName)

Parameters

Type	Name	Description
FunctionOutputParameterDefinition	self	The FunctionOutputParameter instance.
System.String	conversionFunctionName	the name of the conversion function

Returns

Type	Description
FunctionOutputParameterDefinition	The FunctionOutputParameterDefinition.

DataBitMask(FunctionOutputParameterDefinition, UInt32)

Sets DataBitMask

Declaration

public static FunctionOutputParameterDefinition DataBitMask(this FunctionOutputParameterDefinition self, uint dataBitMask)

Parameters

Type	Name	Description
FunctionOutputParameterDefinition	self	The FunctionOutputParameter instance.
System.UInt32	dataBitMask	The mask to use with this parameter

Returns

Type	Description
FunctionOutputParameterDefinition	The FunctionOutputParameterDefinition.

ErrorBitMask(FunctionOutputParameterDefinition, UInt32)

Sets ErrorBitMask

Declaration

public static FunctionOutputParameterDefinition ErrorBitMask(this FunctionOutputParameterDefinition self, uint errorBitMask)

Parameters

Type	Name	Description
FunctionOutputParameterDefinition	self	The FunctionOutputParameter instance.
System.UInt32	errorBitMask	The mask to use to provide an error value for this parameter

Returns

Type	Description
FunctionOutputParameterDefinition	The FunctionOutputParameterDefinition.

FormatOverride(FunctionOutputParameterDefinition, String)

Sets ConversionFunctionName

Declaration

public static FunctionOutputParameterDefinition FormatOverride(this FunctionOutputParameterDefinition self, string formatOverride)

Parameters

Type	Name	Description
FunctionOutputParameterDefinition	self	The FunctionOutputParameter instance.
System.String	formatOverride	Format override for this parameter

Returns

Type	Description
FunctionOutputParameterDefinition	The FunctionOutputParameterDefinition.

MaximumValue(FunctionOutputParameterDefinition, String)

Sets the display max.

Declaration

public static FunctionOutputParameterDefinition MaximumValue(this FunctionOutputParameterDefinition self, string maximum)

Parameters

Type	Name	Description
FunctionOutputParameterDefinition	self	The FunctionOutputParameter instance.
System.String	maximum	The display max value.

Returns

Type	Description
FunctionOutputParameterDefinition	The FunctionOutputParameterDefinition.

MinimumValue(FunctionOutputParameterDefinition, String)

Sets the display min.

Declaration

public static FunctionOutputParameterDefinition MinimumValue(this FunctionOutputParameterDefinition self, string minimum)

Parameters

Type	Name	Description
FunctionOutputParameterDefinition	self	The FunctionOutputParameter instance.
System.String	minimum	The display min value.

Returns

Type	Description
FunctionOutputParameterDefinition	The FunctionOutputParameterDefinition.

OffsetValue(FunctionOutputParameterDefinition, Double)

Sets OffsetValue

Declaration

public static FunctionOutputParameterDefinition OffsetValue(this FunctionOutputParameterDefinition self, double offsetValue)

Parameters

Type	Name	Description
FunctionOutputParameterDefinition	self	The FunctionOutputParameter instance.
System.Double	offsetValue	The off set value

Returns

Type	Description
FunctionOutputParameterDefinition	The FunctionOutputParameterDefinition.

Units(FunctionOutputParameterDefinition, String)

Sets Units

Declaration

public static FunctionOutputParameterDefinition Units(this FunctionOutputParameterDefinition self, string units)

Parameters

Type	Name	Description
FunctionOutputParameterDefinition	self	The FunctionOutputParameter instance.
System.String	units	The units to use in the conversion

Returns

Type	Description
FunctionOutputParameterDefinition	The FunctionOutputParameterDefinition.

WarningMaximumValue(FunctionOutputParameterDefinition, Double)

Sets the display warning max.

Declaration

public static FunctionOutputParameterDefinition WarningMaximumValue(this FunctionOutputParameterDefinition self, double warningMax)

Parameters

Type	Name	Description
FunctionOutputParameterDefinition	self	The FunctionOutputParameter instance.
System.Double	warningMax	The warning max value.

Returns

Type	Description
FunctionOutputParameterDefinition	The FunctionOutputParameterDefinition.

WarningMinimumValue(FunctionOutputParameterDefinition, Double)

Sets the display warning min.

Declaration

public static FunctionOutputParameterDefinition WarningMinimumValue(this FunctionOutputParameterDefinition self, double warningMin)

Parameters

Type	Name	Description
FunctionOutputParameterDefinition	self	The FunctionOutputParameter instance.
System.Double	warningMin	The warning min value.

Returns

Type	Description
FunctionOutputParameterDefinition	The FunctionOutputParameterDefinition.