Task Factory Functions List G-H
GetChar |
||
|---|---|---|
| Description | GetChar returns the character at a specified index in a string. | |
| Syntax | GetChar( String_Value, Index ) | |
| Returns | Single character. NULL if a value passed to the function is NULL. | |
| Parameters | ||
| Name | Optional | Description |
| String_Value | false | Character string. The string value to return a character from. |
| Index | false | Character 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 |
||
|---|---|---|
| Description | Get a property from a connection manager. | |
| Syntax | GetConnectionProp( Connection_Manager, Property_Name ) | |
| Returns | String. | |
| Parameters | ||
| Name | Optional | Description |
| Connection_Manager | false | Connection manager to retrieve a property from. Must use the @@[connection_manager_name] syntax. |
| Property_Name | false | String value. The property to retrieve from the connection manager. |
| Examples | ||
| GetConnectionProp(@@[localhost.AdventureWorks], "ServerName") | ||
GetDate |
||
|---|---|---|
| Description | Returns the current date and time. | |
| Syntax | GetDate() | |
| Returns | Date | |
| Examples | ||
| GetDate() | ||
GetDatePart |
||
|---|---|---|
| Description | Returns the part of the date specified in the datepart parameter. | |
| Syntax | GetDatePart( Date, Date_Part ) | |
| Returns | Object. | |
| Parameters | ||
| Name | Optional | Description |
| Date | false | The date used to retrieve the datepart from. |
| Date_Part | false | The 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 |
||
|---|---|---|
| Description | Returns the amount of free disk space in megabytes. | |
| Syntax | GetDiskFreeSpace( Drive_Letter ) | |
| Returns | Integer. The amount of free disk space in megabytes | |
| Parameters | ||
| Name | Optional | Description |
| Drive_Letter | false | The drive letter to determine disk space. Must include :\ with the drive letter (e.g. C:\). |
| Examples | ||
| GetDiskFreeSpace("C:\") | ||
GetDiskSize |
||
|---|---|---|
| Description | Returns the amount of disk space for a drive in megabytes. | |
| Syntax | GetDiskSize( Drive_Letter ) | |
| Returns | Integer. The amount of disk space in megabytes | |
| Parameters | ||
| Name | Optional | Description |
| Drive_Letter | false | The drive letter to determine disk space. Must include :\ with the drive letter (e.g. C:\). |
| Examples | ||
| GetDiskSize("C:\") | ||
GetUtcDate |
||
|---|---|---|
| Description | Returns the current utc date and time. | |
| Syntax | GetUtcDate() | |
| Returns | Date | |
| Examples | ||
| GetUtcDate() | ||
Greatest |
||
|---|---|---|
| Description | Returns 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. | |
| Syntax | GREATEST( Case_Flag, Value1 [, Value2, ..., ValueN,] ) | |
| Returns | value1 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 | ||
| Name | Optional | Description |
| Value | false | Any 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_Flag | false | Must 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 |
||
|---|---|---|
| Description | Returns 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 | |
| Syntax | GroupNum() | |
| Returns | Integer | |
| Examples | ||
| GroupNum() | ||
GroupRowNum |
||
|---|---|---|
| Description | Returns the number of rows that were used in this aggregation group. | |
| Syntax | GroupRowNum() | |
| Returns | Integer | |
| Examples | ||
| GroupRowNum() | ||
Hex |
||
|---|---|---|
| Description | Convert a value to Hex value. | |
| Syntax | Hex( Value ) | |
| Returns | String. Returns the Hex value of the integer. | |
| Parameters | ||
| Name | Optional | Description |
| Value | false | The integer value to convert to Hex. |
| Examples | ||
| Hex(18), Hex(varValue) | ||
HexToBin |
||
|---|---|---|
| Description | Converts a hexical value to a binary value. | |
| Syntax | HexToBin( Value ) | |
| Returns | String | |
| Parameters | ||
| Name | Optional | Description |
| Value | false | The hexadecimal value to convert. |
| Examples | ||
| HexToBin(10) | ||
HexToDecimal |
||
|---|---|---|
| Description | Converts a hexical value to a decimal value. | |
| Syntax | HexToDecimal( Value ) | |
| Returns | Int64 | |
| Parameters | ||
| Name | Optional | Description |
| Value | false | The hexadecimal value to convert. |
| Examples | ||
| HexToDecimal(10) | ||
HexToOct |
||
|---|---|---|
| Description | Converts a hexical value to a octal value. | |
| Syntax | HexToOct( Value ) | |
| Returns | String | |
| Parameters | ||
| Name | Optional | Description |
| Value | false | The hexadecimal value to convert. |
| Examples | ||
| HexToOct(10) | ||
Hour |
||
|---|---|---|
| Description | Returns the hour from the date specified. | |
| Syntax | Hour( Date ) | |
| Returns | returns integer value of 1 - 24 | |
| Parameters | ||
| Name | Optional | Description |
| Date | false | Date to retrieve Hour from |
| Examples | ||
| Hour("12/8/2011"), Hour(varDate), Hour(OrderDateColumn) | ||