Funções de string no Jitterbit Studio

As funções de string são o mecanismo para a manipulação de strings em scripts.

CountSubString

Declaração

int CountSubString(string str, string subStr)

Sintaxe

CountSubString(<str>, <subStr>)

Parâmetros obrigatórios

• str: Uma string a ser pesquisada
• subStr: A string a ser pesquisada

Descrição

Retorna o número de vezes que uma sub-string aparece em uma string.

Exemplos

CountSubString("Mississippi", "iss"); // Retorna 2

DQuote

Declaração

string DQuote(string str)

Sintaxe

DQuote(<str>)

Parâmetros obrigatórios

• str: Uma string a ser colocada entre aspas duplas

Descrição

Coloca uma string entre aspas duplas e retorna o resultado. Aspas duplas embutidas não são escapadas.

Exemplos

DQuote("any str"); // Returns ""any str""

DQuote('any "text" str');
// Returns ""any "text" str"" -- note that the embedded double quotes are not escaped

Format

Declaração

string Format(string formatStr, type de)

Sintaxe

Format(<formatStr>, <de>)

Parâmetros obrigatórios

• formatStr: A string de formato a ser usada ao formatar a string
• de: Um elemento de dados; se necessário, será convertido em uma string antes de ser formatado

Descrição

Retorna uma string no formato especificado por uma string de formato.

A especificação de formato é a mesma utilizada nas funções de data e hora; veja a seção sobre strings de formato. É semelhante à especificação de formato da biblioteca padrão C printf.

Esta função pode ser usada para definir o formato de saída para um alvo. É útil quando o formato de saída padrão do Jitterbit para um tipo de dado (como data ou double) não é o desejado. A chamada à função Format deve ser a última chamada em uma fórmula de mapeamento para que ela seja o valor mapeado.

Exemplos

Format("'%5d'", 2); // Retorna "'    2'"

Index

Declaração

int Index(string str, string subStr[, int n])

Sintaxe

Index(<str>, <subStr>[, <n>])

Parâmetros obrigatórios

• str: Uma string a ser pesquisada
• subStr: A string a ser pesquisada

Parâmetros opcionais

• n: A instância específica de interesse se houver mais de uma correspondência

Descrição

Retorna a posição de uma sub-string dentro de uma string.

Nos casos em que a sub-string aparece mais de uma vez na string principal, o terceiro argumento (n) é usado para determinar qual instância específica da sub-string é de interesse.

• Se n < 0, a contagem das instâncias começa a partir do final da string principal.
• Se |n| > o número máximo de vezes que a sub-string aparece na string principal, a função retorna -1.

Caso contrário, a função retorna a posição do primeiro caractere da sub-string dentro da string principal (começando na posição 0).

Casos especiais a considerar:

• n = 0 retorna o mesmo resultado que n = 1

• Se subStr for uma string vazia (""):

  • n >= 0 sempre retorna 0

  • n < 0 sempre retorna Length(str)

Exemplos

Index("Mississippi", "s"); // Returns 2
// When called with only two arguments
// the optional third argument defaults to 1,
// resulting in the index of the first match being returned

Index("Mississippi", "iss", 3); // Returns -1
// Searching for the 3rd instance of "iss" within Mississippi

Index("Mississippi", "si", 2); // Returns 6
// The 2nd instance of the sub-string
// "si" starts at position 6 as the
// first letter "M" starts at position 0

Index("Mississippi", "", 1); // Returns 0
Index("Mississippi", "", -1); // Returns 11

IsValidString

Declaração

bool IsValidString(string str)

Sintaxe

IsValidString(<str>)

Parâmetros obrigatórios

• str: Uma string a ser validada

Descrição

Retorna verdadeiro se cada caractere em uma string for válido. Os caracteres válidos são os códigos ASCII de 32 a 126 inclusivos e qualquer um dos caracteres de avanço de linha (LF), retorno de carro (CR) ou tabulação (TAB).

Exemplos

IsValidString("An Invalid String™");
// Returns 0 (false), as the trademark symbol in this font is a code greater than 128

IsValidString("A Valid Broken
String");
// Returns 1 (true)

Left

Declaração

string Left(string str, int n)

Sintaxe

Left(<str>, <n>)

Parâmetros obrigatórios

• str: Uma string
• n: O número de caracteres a partir da extremidade esquerda a serem retornados

Descrição

Retorna n caracteres de uma string, contando a partir da esquerda (o início) de uma string.

Veja também as funções Mid e Right.

Exemplos

Left("01234567890", 4);
// Retorna "0123"

LPad

Declaração

string LPad(string str, int n)

Sintaxe

LPad(<str>, <n>)

Parâmetros obrigatórios

• str: Uma string
• n: O número de caracteres a partir da extremidade esquerda a ser retornado

Descrição

Adiciona espaços à esquerda (o início) de uma string até que a string contenha n caracteres. Strings contendo n ou mais caracteres são truncadas para n caracteres.

LPad(str, -n) é o mesmo que RPad(str, n). Veja a função RPad.

Exemplos

LPad("01234567", 9);
// Returns " 01234567"
// Adds one space to the left side
// of the original string

LPad("1234567890", 9);
// Returns "123456789"

LPadChar

Declaração

string LPadChar(string str, string padChar, int n)

Sintaxe

LPadChar(<str>, <padChar>, <n>)

Parâmetros obrigatórios

• str: Uma string
• padChar: Uma string a ser usada para preencher caracteres; se houver mais de um caractere, o primeiro caractere é usado
• n: O número de caracteres a partir da extremidade esquerda a ser retornado

Descrição

Adiciona um caractere de preenchimento à esquerda (o início) de uma string até que a string contenha n caracteres. Strings contendo n ou mais caracteres são truncadas para n caracteres.

LPadChar(str, " ", n) é o mesmo que LPad(str, n). Veja a função LPad.

Exemplos

LPadChar(1234567, "0", 10);
// Returns "0001234567"
LPadChar(1234567, ".0", 10);
// Returns "...1234567"

LTrim

Declaração

string LTrim(string str)

Sintaxe

LTrim(<str>)

Parâmetros obrigatórios

• str: Uma string

Descrição

Remove espaços em branco (espaços, tabulações) da esquerda (o início) de uma string e retorna os caracteres restantes.

Exemplos

LTrim(" Hello World!  ");
// Returns "Hello World!  "

LTrim("    Hello World!");
// Removes the leading tab character
// and returns "Hello World!"

LTrimChars

Declaração

string LTrimChars(string str, string trimChars)

Sintaxe

LTrimChars(<str>, <trimChars>)

Parâmetros obrigatórios

• str: Uma string a ser cortada pela esquerda (o início)**
  
• trimChars: Uma string de caracteres de corte a serem correspondidos; a ordem não importa

Descrição

Remove quaisquer caracteres iniciais em uma string pela esquerda (o início) que correspondam aos caracteres de corte e retorna os caracteres restantes.

Essa função testa cada caractere inicial de uma string, começando na borda esquerda, e verifica se ele é encontrado nos caracteres de corte. Se for, ele é removido, e o processo se repete até que não haja mais correspondência.

Isso pode ser usado para cortar caracteres além dos caracteres de espaço em branco padrão, como cortar dois pontos iniciais.

Veja também as funções RTrimChars e TrimChars.

Exemplos

LTrimChars("::StartMsg :: Hello :: EndMsg::", ":");
// Returns "StartMsg :: Hello :: EndMsg::"

LTrimChars("// This is a comment", " /");
// Returns "This is a comment"

LTrimChars("// This is a comment", "/ ");
// Returns "This is a comment"

LTrimChars("// This is a comment", "/");
// Returns " This is a comment"

LTrimChars("// This is a comment", " ");
// Returns "// This is a comment"
// Returns the string unchanged as a space
// was not a leading character

Mid

Declaração

string Mid(string str, int m, int n)

Sintaxe

Mid(<str>, <m>, <n>)

Parâmetros obrigatórios

• str: Uma string da qual extrair uma sub-string

• m: A posição do caractere inicial baseada em zero para começar a extrair a sub-string

• n: O comprimento (número de caracteres) da sub-string a ser extraída

Descrição

Retorna uma parte de uma string, começando com o caractere na posição m por um comprimento de n caracteres.

Veja também as funções Left e Right.

Exemplos

Mid("Jitterbit", 2, 3);
// Returns "tte"

Mid("01234567890", 7, 3);
// Returns "789"

// Passing the same string as an
// integer with a leading zero
// returns a different result
Mid(01234567890, 7, 3);
// Returns "890"

ParseURL

Declaração

array ParseURL(string url)

Sintaxe

ParseURL(<url>)

Parâmetros obrigatórios

• url: Uma string contendo uma URL para análise

Descrição

Analisa uma string de URL e retorna um array de valores decodificados. Os valores são marcados para que possam ser recuperados tanto por índice quanto por nome de campo.

Ao recuperar valores do resultado, a capitalização de um nome de campo é ignorada. Veja também as funções URLDecode e URLEncode.

Exemplos

url = "http://hostname/user?email=john1990%40example.com&name=John%20Smith";
arr = ParseURL(url);

email = arr[0];
// "email" will be john1990@example.com
email = arr["email"];
// same as previous

name = arr["name"];
// "name" will be "John Smith"
name = arr["Name"];
// Same as previous;
// case is ignored for field names

Quote

Declaração

string Quote(string str)

Sintaxe

Quote(<str>)

Parâmetros obrigatórios

• str: Uma string a ser colocada entre aspas simples

Descrição

Coloca uma string entre aspas simples e retorna o resultado. Aspas simples embutidas não são escapadas.

Exemplos

Quote("Any string");
// Returns "'Any string'"

Quote("Ain't escaped");
// Returns "'Ain't escaped'" -- note that the embedded quote is not escaped.

RegExMatch

Declaração

int RegExMatch(string str, string exp[, type var1,... type varN])

Sintaxe

RegExMatch(<str>, <exp>[, <var1>,... <varN>])

Parâmetros obrigatórios

• str: Uma string a ser comparada

• exp: Uma expressão regular que consiste em grupos

Parâmetros opcionais

• var1...varN: Um ou mais nomes de variáveis, a serem correspondidos às sub-expressões marcadas da expressão

Descrição

Corresponde a uma expressão regular com uma string de entrada, armazena as sub-expressões marcadas em variáveis e retorna o número de correspondências.

Retorna o número total de sub-expressões marcadas (que pode ser mais ou menos do que o número de variáveis realmente fornecidas). Quaisquer correspondências adicionais que excedam o número de variáveis fornecidas são descartadas. Se não houver correspondências, -1 é retornado.

A expressão regular segue a sintaxe da biblioteca de expressões regulares Boost. É uma variação da sintaxe de expressões regulares Perl.

Os caracteres Unicode, incluindo símbolos como emoji, devem ser correspondidos usando seus caracteres literais e não usando sequências de escape Unicode. Por exemplo, o intervalo "[😀-🤯]" (U+1F600 a U+1F92F) captura com sucesso o símbolo 🤔 (U+1F914) entre eles.

Veja também a função RegExReplace.

Exemplos

expression = "\D*";
// Expression that matches what aren't digits.

$reg_1 = RegExMatch("123", expression);
// Returns -1 because the input string contains digits.

$reg_2 = RegExMatch("123A" ,expression);
// Returns -1 because the input string starts with digits.

$reg_3 = RegExMatch("ABC", "[a-zA-Z]*");
// Returns 0 because a match was found with without matching sub-expressions.

$reg_4 = RegExMatch("a", "[a-z]");
// Returns 0 because the single character matches what the expression expected.

$reg_5 = RegExMatch("ab", "[a-z]");
// Returns -1 because the expression does not cover the entire input string and is expecting a single character.
// Refer to the note above for additional information.

$reg_6 = RegExMatch("ab", "[a-z]+");
// Returns 0.

$reg_7 = RegExMatch("ab", "a*b", "reg_7_value");
// Returns 0.
// Does not set the global variable "$reg_7_value" because there are no sub-expressions.

$reg_8 = RegExMatch("ab", "(a*b)", "reg_8_value");
// Returns 1 because the sub-expression was matched.
// Sets the global variable "$reg_8_value" to "ab".

$reg_9 = RegExMatch("[abc]", "(\\[)(.*)(\\])", "reg_9_test", "reg_9_value");
result = $reg_9;
// Sets the global variable "$reg_9_test" to "[".
// Sets the global variable "$reg_9_value" to "abc".
// Returns 3 because the character "]" also matched the last sub-expression.
// However, as there are only two variable names, the last match is not saved to a variable.

RegExReplace

Declaração

string RegExReplace(string str, string exp, string format)

Sintaxe

RegExReplace(<str>, <exp>, <format>)

Parâmetros obrigatórios

• str: Uma string a ser pesquisada e ter quaisquer sub-strings correspondentes substituídas

• exp: A expressão regular na sintaxe da biblioteca de expressões regulares Boost a ser usada para corresponder sub-strings da string

• format: Uma string de formato na Sintaxe de String de Formato Estendida Boost

Descrição

Substitui todas as sub-strings em uma string que correspondem a uma expressão, usando um formato especificado para substituir cada sub-string. Quaisquer seções da string que não correspondem à expressão são passadas para a string retornada sem alterações.

A expressão regular segue a sintaxe da biblioteca de expressões regulares Boost. É uma variação da sintaxe de expressões regulares Perl.

Caracteres Unicode, incluindo símbolos como emoji, devem ser correspondidos usando seus caracteres literais e não usando sequências de escape Unicode. Por exemplo, o intervalo "[😀-🤯]" (U+1F600 a U+1F92F) captura com sucesso o símbolo 🤔 (U+1F914) entre eles.

A string de formato segue a Sintaxe de String de Formato Estendida Boost. Se a string de formato for uma string vazia (""), então uma correspondência não produz resultado para essa sub-string.

Veja também a função RegExMatch.

Exemplos

// To remove any whitespace from a string:
RegExReplace(" t e st ss s", "\\s", "");
// Returns "testsss"

// To swap the order of sub-strings:
RegExReplace("abc(first)123(second)xyz",
             "(.*)(\\(.*\\))(.*)(\\(.*\\))(.*)",
             "\\1aaa\\4\\2\\3\\5");
// Returns "abcaaa(second)(first)123xyz"

// To pass backslashes in matches, multiple instances may be required.
// In the "r" example, three backslashes are used and then doubled.
// The first two backslashes convert into a single backslash,
// which then escapes the next backslash.
// All three backslashes are then doubled for Jitterbit script.
s = "test\\ing";  // "test\ing";
t = RegExReplace(s, "\\\\", "!");  // "test\ing" -> "test!ing"
r = RegExReplace(t, "!", "\\\\\\");  // "test!ing" ->  "test\\ing"

Replace

Declaração

string Replace(string str, string old, string new)

Sintaxe

Replace(<str>, <old>, <new>)

Parâmetros obrigatórios

• str: Uma string a ser pesquisada e sub-strings correspondentes substituídas

• old: Uma string a ser usada para a correspondência

• new: Uma string a ser usada como substituição para quaisquer correspondências encontradas

Descrição

Pesquisa uma string por sub-strings que correspondem ao argumento "old" e substitui uma sub-string correspondente pelo argumento "new".

Para operações de busca e substituição mais complexas, veja a função RegExReplace.

Exemplos

Replace("Segunda Terça", "day", "noite,");
// Retorna "Segunda noite, Terça noite,"

Right

Declaração

string Right(string str, int n)

Sintaxe

Right(<str>, <n>)

Parâmetros obrigatórios

• str: Uma string

• n: O número de caracteres a partir da extremidade direita a ser retornado

Descrição

Retorna n caracteres de uma string, contando a partir da direita (a extremidade) de uma string.

Veja também as funções Left e Mid.

Exemplos

Right("01234567890",4);
// Retorna "7890"

RPad

Declaração

string RPad(string s, int n)

Sintaxe

string RPad(string s, int n)

Parâmetros obrigatórios

• str: Uma string

• n: O número de caracteres a partir da extremidade direita a ser retornado

Descrição

Adiciona espaços à direita (na extremidade) de uma string até que a string contenha n caracteres. Strings contendo n ou mais caracteres são truncadas para n caracteres.

RPad(str, -n) é o mesmo que LPad(str, n). Veja a função LPad.

Exemplos

RPad("01234567",9);
// Retorna "01234567 "

RPadChar

Declaração

string RPadChar(string str, string padChar, int n)

Sintaxe

RPadChar(<str>, <padChar>, <n>)

Parâmetros obrigatórios

• str: Uma string
• padChar: Uma string a ser usada para preencher caracteres; se houver mais de um caractere, o primeiro caractere é usado
• n: O número de caracteres a partir da extremidade direita a ser retornado

Descrição

Adiciona um caractere de preenchimento à direita (na extremidade) de uma string até que a string contenha n caracteres. Strings contendo n ou mais caracteres são truncadas para n caracteres.

RPadChar(str, " ", n) é o mesmo que RPad(str, n). Veja a função RPad.

Exemplos

RPadChar(1234567, "0", 10);
// Retorna "1234567000"

RTrim

Declaração

string RTrim(string str)

Sintaxe

RTrim(<str>)

Parâmetros obrigatórios

• str: Uma string

Descrição

Remove espaços em branco (espaços, tabulações) do lado direito (o final) de uma string e retorna os caracteres restantes.

Exemplos

RTrim(" Hello World!  ");
// Returns " Hello World!"

RTrim("Hello World!    ");
// Removes the trailing tab character
// and returns "Hello World!"

RTrimChars

Declaração

string RTrimChars(string str, string trimChars)

Sintaxe

RTrimChars(<str>, <trimChars>)

Parâmetros obrigatórios

• str: Uma string a ser cortada do lado direito (o final)**
  
• trimChars: Uma string de caracteres de corte a serem correspondidos; a ordem não importa

Descrição

Remove quaisquer caracteres finais em uma string do final que correspondam aos caracteres de corte e retorna os caracteres restantes.

Esta função testa cada caractere final de uma string, começando na borda direita, e verifica se ele é encontrado nos caracteres de corte. Se for, ele é removido, e o processo se repete até que não haja mais correspondência.

Isso pode ser usado para cortar caracteres além dos caracteres de espaço em branco padrão, como cortar dois pontos finais.

Veja também as funções LTrimChars e TrimChars.

Exemplos

RTrimChars("::StartMsg :: Hello :: EndMsg::", ":");
// Returns "::StartMsg :: Hello :: EndMsg"

RTrimChars("// This is a comment //", " /");
// Returns "// This is a comment"

RTrimChars("// This is a comment //", "/");
// Returns "// This is a comment "

RTrimChars("// This is a comment //", " ");
// Returns "// This is a comment //"
// Returns the string unchanged as a space
// was not a trailing character

Split

Declaração

array Split(string str, string delimiter)

Sintaxe

Split(<str>, <delimiter>)

Parâmetros obrigatórios

• str: Uma string a ser dividida
• delimiter: Uma string a ser correspondida como o separador entre cada elemento do array

Descrição

Divide uma string usando uma string delimitadora, retornando o resultado como um array.

Retorna o resultado em um array de tamanho igual ao número de delimitadores mais um. Se a expressão terminar com o delimitador, o tamanho do array é igual ao número de delimitadores (o último valor vazio é ignorado). Se a string não contiver delimitadores, um array de tamanho um é retornado contendo a string original.

Exemplos

arr = Split("Donald,Minnie,Goofy", ",");
donald = arr[0];
minnie = arr[1];
goofy = arr[2];

Split("Donald.,Minnie.,Goofy.,", ".,");
// Returns the array {Donald, Minnie, Goofy}

Este exemplo converte um endereço IP ("10.6.10.1") em um único inteiro (168167937):

// Logic: (first octet * 16777216) + (second octet * 65536) +
//   (third octet * 256) + (fourth octet)
ip = "10.6.10.1";
ipList = Split(ip, ".");
(Int(ipList[0]) * 16777216) + (Int(ipList[1]) * 65536) +
    (Int(ipList[2]) * 256) + (Int(ipList[3]));

SplitCSV

Declaração

array Split(string str[, string delimiter, int qualifier])

Sintaxe

Split(<str>[, <delimiter>, <qualifier>])

Parâmetros obrigatórios

• str: Uma string a ser dividida

Parâmetros opcionais

• delimiter: Uma string a ser correspondida como o separador entre cada elemento do array
• qualifier: Uma string a ser correspondida como o separador entre cada elemento do array

Descrição

Divide uma string formatada em CSV e retorna um array com os valores individuais das colunas.

Por padrão, o delimitador é uma vírgula (,) e o qualificador de string é uma aspa dupla ("). Isso pode ser alterado especificando os segundos e terceiros argumentos opcionais, respectivamente.

Exemplos

arr = SplitCSV('"Donald","Minnie ""The Mouse""", Goofy');
donald = arr[0];
// Returns "Donald"
minnie = arr[1];
// Returns "Minnie ""The Mouse"""
goofy = arr[2];
// Returns "Goofy"

StringLength

Declaração

int StringLength(string str)

array StringLength(array arr)

Sintaxe

StringLength(string str)

StringLength(array arr)

Parâmetros obrigatórios

• str: (Primeira forma) Uma string

• arr: (Segunda forma) Um array

Descrição

Retorna o comprimento de uma string.

A função retorna um array se o argumento for um array, com cada elemento do array retornado sendo o comprimento do elemento correspondente do array de argumento. A função Length retorna o comprimento de um array em vez do comprimento dos elementos individuais.

Exemplos

arr = {a="abcd", b="e"};

StringLength(arr);
// Returns the array {4,1}

Length(arr);
// Returns 2

ToLower

Declaração

string ToLower(string str)

Sintaxe

ToLower(<str>)

Parâmetros obrigatórios

• str: Uma string

Descrição

Converte todos os caracteres maiúsculos ASCII (A a Z, ASCII 65 a 90) em uma string para minúsculas.

Exemplos

ToLower("Hello World!");
// Retorna "hello world!"

ToProper

Declaração

string ToProper(string str)

Sintaxe

ToProper(<str>)

Parâmetros obrigatórios

• str: Uma string

Descrição

Converte uma string para a forma correta (a primeira letra de cada palavra é capitalizada). Isso é distinto da forma de título, que apenas capitaliza palavras selecionadas e mais longas em uma string.

s = "mccartney, paul";
s = Right( ToProper( " " + s), Length(s));

Exemplos

ToProper("bob dylan");
// Returns "Bob Dylan"
ToProper("arthur c. Clarke");
// Returns "Arthur C. Clarke"
ToProper("Peter o'toole");
// Returns "Peter O'Toole"

ToUpper

Declaração

string ToUpper(string <str>)

Sintaxe

ToUpper(<str>)

Parâmetros obrigatórios

• str: Uma string

Descrição

Converte todos os caracteres ASCII minúsculos (a até z, ASCII 97 até 122) em uma string para maiúsculas.

Exemplos

ToUpper("Hello World!");
// Retorna "HELLO WORLD!"

Trim

Declaração

string Trim(string str)

Sintaxe

Trim(<str>)

Parâmetros obrigatórios

• str: Uma string

Descrição

Remove espaços em branco do início e do fim de uma string e retorna os caracteres restantes.

Exemplos

Trim(" Hello World! ");
// Retorna "Hello World!"

TrimChars

Declaração

string TrimChars(string str, string trimChars)

Sintaxe

TrimChars(<str>, <trimChars>)

Parâmetros obrigatórios

• str: Uma string a ser cortada
• trimChars: Uma string de caracteres de corte a serem correspondidos; a ordem não importa

Descrição

Remove quaisquer caracteres iniciais ou finais em uma string que correspondam àqueles nos caracteres de corte e retorna os caracteres restantes.

Essa função testa cada caractere inicial e final de uma string e verifica se ele é encontrado nos caracteres de corte. Se for, é removido, e o processo se repete até que não haja mais correspondências.

Isso pode ser usado para cortar caracteres além dos caracteres de espaço em branco padrão, como cortar dois pontos.

Veja também as funções LTrimChars e RTrimChars.

Exemplos

TrimChars("::StartMsg :: Hello :: EndMsg::", ":");
// Returns "StartMsg :: Hello :: EndMsg"

TrimChars("/* This is a comment */", " /*");
// Returns "This is a comment"

Truncate

Declaração

string Truncate(string str, int firstChars, int lastChars)

Sintaxe

Truncate(<str>, <firstChars>, <lastChars>)

Parâmetros obrigatórios

• str: Uma string
• firstChars: O número de caracteres a serem removidos da esquerda (do início) da string
• lastChars: O número de caracteres a serem removidos da direita (do final) da string

Descrição

Remove firstChar caracteres da esquerda (do início) e lastChars caracteres da direita (do final) de uma string e retorna a string restante.

Veja também as funções Left e Right.

Exemplos

Truncate("a,b,c,", 2, 1);
// Retorna "b,c"

URLDecode

Declaração

string URLDecode(string url, string paramName)

Sintaxe

URLDecode(<url>, <paramName>)

Parâmetros obrigatórios

• url: Uma string contendo uma URL
• paramName: O nome de um parâmetro na URL cujo valor deve ser retornado

Descrição

Analisa uma string de URL e retorna o valor decodificado do parâmetro da URL com o nome especificado. A capitalização do nome é ignorada. Se o nome não for encontrado nos parâmetros da URL, uma string vazia ("") é retornada.

Veja também as funções ParseURL e URLEncode.

Exemplos

url = "http://hostname/user?email=john1990%40gmail.com&name=John%20Smith";
URLDecode(url, "name");
// Retorna "John Smith"

URLEncode

Declaração

string URLEncode(string str[, int encodingOption])

Sintaxe

URLEncode(<str>[, <encodingOption>])

Parâmetros obrigatórios

• url: Uma string contendo um valor a ser codificado seguindo as regras do RFC 1738

Parâmetros opcionais

• encodingOption: Um inteiro (0 - 3) que especifica a codificação a ser utilizada. O valor padrão é 0. Veja a lista abaixo.

Descrição

Codifica uma string seguindo RFC 1738.

Os valores válidos para a opção de codificação opcional são:

• 0: Codificação padrão de URL. Codifica caracteres de controle ASCII, caracteres não-ASCII, caracteres "reservados" e caracteres "inseguros". Esta é a codificação padrão se a opção for omitida.
• 1: Não codifica caracteres "inseguros": " \< ;> ; # % { } | \ ^ \~ [ ] ` e o caractere de espaço
• 2: Não codifica caracteres "reservados": ; / ? : @ & =
• 3: Não codifica caracteres "inseguros" e caracteres "reservados"

Estes caracteres são considerados "seguros" e nunca são codificados: $ - _ . + ! * ' ( ) ,

Veja também as funções ParseURL e URLDecode.

Exemplos

value1 = "FIRST#"; value2 = "<LAST>";
url = "http://hostname/get_doc?" +
    "name1=" + URLEncode(value1) +
    "&name2=" + URLEncode(value2);
// Returns
// http://hostname/get_doc?name1=FIRST%23&name2=%3CLAST%3E