Task Factory Functions List G-H

GetChar

GetChar

DescriptionGetChar returns the character at a specified index in a string.
SyntaxGetChar( String_Value, Index )
ReturnsSingle character. NULL if a value passed to the function is NULL.
Parameters
NameOptionalDescription
String_ValuefalseCharacter string. The string value to return a character from.
IndexfalseCharacter string. The index of the character you want returned from the String_Value parameter .
Examples
GetChar("GetTheC", 7), If GetChar(AddressColumn, 1) = "A" Then ...
GetConnectionProp

GetConnectionProp

DescriptionGet a property from a connection manager.
SyntaxGetConnectionProp( Connection_Manager, Property_Name )
ReturnsString.
Parameters
NameOptionalDescription
Connection_ManagerfalseConnection manager to retrieve a property from. Must use the @@[connection_manager_name] syntax.
Property_NamefalseString value. The property to retrieve from the connection manager.
Examples
GetConnectionProp(@@[localhost.AdventureWorks], "ServerName")
GetDate

GetDate

DescriptionReturns the current date and time.
SyntaxGetDate()
ReturnsDate
Examples
GetDate()
 GetDatePart

GetDatePart

DescriptionReturns the part of the date specified in the datepart parameter.
SyntaxGetDatePart( Date, Date_Part )
ReturnsObject.
Parameters
NameOptionalDescription
DatefalseThe date used to retrieve the datepart from.
Date_PartfalseThe datepart tells the DatePart what part of the date to retrieve. <br /> The datepart tells the DatePart what part of the date to retrieve. <br /> Year = "Y", "YY", "YYY", "YYYY"<br /> Day = "D", "DD", "DDD", "DY", "DAY"<br /> Month = "MM", "MON", "MONTH"<br /> Hour = "HH", "HH12", "HH24"<br /> Minute = "MI"<br /> Second = "SS""<br /> Millisecond = "MS"<br /> Microsecond = ""US"<br /> Day Of Week (1-7) = "WD","W" <br /> Week Of Year = "WW"<br /> Day Of Year = "YD"<br /> Quarter = "Q"<br /> Julian Date = "J"
Examples
GetDatePart("7/4/2012", "d"), GetDatePart(varStartDate, "MM"),GetDatePart(OrderDateColumn, "HH")
 GetDiskFreeSpace

GetDiskFreeSpace

DescriptionReturns the amount of free disk space in megabytes.
SyntaxGetDiskFreeSpace( Drive_Letter )
ReturnsInteger. The amount of free disk space in megabytes
Parameters
NameOptionalDescription
Drive_LetterfalseThe drive letter to determine disk space. Must include :\ with the drive letter (e.g. C:\).
Examples
GetDiskFreeSpace("C:\")
 GetDiskSize

GetDiskSize

DescriptionReturns the amount of disk space for a drive in megabytes.
SyntaxGetDiskSize( Drive_Letter )
ReturnsInteger. The amount of disk space in megabytes
Parameters
NameOptionalDescription
Drive_LetterfalseThe drive letter to determine disk space. Must include :\ with the drive letter (e.g. C:\).
Examples
GetDiskSize("C:\")
GetUtcDate

GetUtcDate

DescriptionReturns the current utc date and time.
SyntaxGetUtcDate()
ReturnsDate
Examples
GetUtcDate()
Greatest

Greatest

DescriptionReturns the greatest value from a list of input values. Use this function to return the greatest string, date, or number. By default, the match is case sensitive.
SyntaxGREATEST( Case_Flag, Value1 [, Value2, ..., ValueN,] )
Returnsvalue1 if it is the greatest of the input values, value2 if it is the greatest of the input values, and so on. NULL if any of the arguments is null.
Parameters
NameOptionalDescription
ValuefalseAny datatype except Binary. Datatype must be compatible with other values. Value you want to compare against other values. You must enter at least one value argument. If the value is numeric, and other input values are numeric, all values use the highest precision possible. For example, if some values are Integer datatype and others are Double datatype, the Integration Service converts the values to Double.
Case_FlagfalseMust be an integer. Determines whether the arguments in this function are case sensitive. You can enter any valid task editor. When CaseFlag is a number other than 0, the function is case sensitive. When CaseFlag is a null value or 0, the function is not case sensitive.
Examples
Greatest(false, varValues), Greatest(false, "test1", "test2", "test3")
GroupNum

GroupNum

DescriptionReturns the group of which this aggregate row belongs to. For instance, if there were 10 rows outputted from the Advanced Aggregate, then GroupNum would add 1-10 for each respective row
SyntaxGroupNum()
ReturnsInteger
Examples
GroupNum()
GroupRowNum

GroupRowNum

DescriptionReturns the number of rows that were used in this aggregation group.
SyntaxGroupRowNum()
ReturnsInteger
Examples
GroupRowNum()
Hex

Hex

DescriptionConvert a value to Hex value.
SyntaxHex( Value )
ReturnsString. Returns the Hex value of the integer.
Parameters
NameOptionalDescription
ValuefalseThe integer value to convert to Hex.
Examples
Hex(18), Hex(varValue)
HexToBin

HexToBin

DescriptionConverts a hexical value to a binary value.
SyntaxHexToBin( Value )
ReturnsString
Parameters
NameOptionalDescription
ValuefalseThe hexadecimal value to convert.
Examples
HexToBin(10)
 HexToDecimal

HexToDecimal

DescriptionConverts a hexical value to a decimal value.
SyntaxHexToDecimal( Value )
ReturnsInt64
Parameters
NameOptionalDescription
ValuefalseThe hexadecimal value to convert.
Examples
HexToDecimal(10)
HexToOct

HexToOct

DescriptionConverts a hexical value to a octal value.
SyntaxHexToOct( Value )
ReturnsString
Parameters
NameOptionalDescription
ValuefalseThe hexadecimal value to convert.
Examples
HexToOct(10)
Hour

Hour

DescriptionReturns the hour from the date specified.
SyntaxHour( Date )
Returnsreturns integer value of 1 - 24
Parameters
NameOptionalDescription
DatefalseDate to retrieve Hour from
Examples
Hour("12/8/2011"), Hour(varDate), Hour(OrderDateColumn)