Funções de String¶

Funções de string são o mecanismo para 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 para pesquisar

Descrição¶

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

Exemplos¶

CountSubString("Mississippi", "iss"); // Returns 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. As aspas duplas incorporadas não têm escape.

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 usado 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 do formato é a mesma usada em Funções de data e hora; veja sua seção sobre strings de formato. É semelhante à biblioteca C padrão printf especificação de formato.

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

Exemplos¶

Format("'%5d'", 2); // Returns "'    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 para pesquisar

Parâmetros Opcionais¶

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

Descrição¶

Retorna a posição de uma substring dentro de uma string.

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

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

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

Casos especiais a considerar:

• n = 0 retorna o mesmo resultado que n = 1
• Se subStr é 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 de uma string for válido. Os caracteres válidos são os códigos ASCII 32 a 126 inclusive e qualquer caractere de avanço de linha (LF), retorno de carro (CR) ou aba (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 linha
• n: O número de caracteres da extremidade esquerda a serem retornados

Descrição¶

Devoluções n caracteres de uma string, contando a partir da esquerda (início) de uma string.

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

Exemplos¶

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

LPad¶

Declaração¶

string LPad(string str, int n)

Sintaxe¶

LPad(<str>, <n>)

Parâmetros Obrigatórios¶

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

Descrição¶

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

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

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 linha
• padChar: Uma string a ser usada para preencher caracteres; se houver mais de um caractere, o primeiro caractere será usado
• n: O número de caracteres da extremidade esquerda a serem retornados

Descrição¶

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

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

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 linha

Descrição¶

Remove espaços em branco (espaços, tabulações) da esquerda (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 da esquerda (o início)**
  
• trimChars:** Uma sequência de caracteres de corte a serem correspondidos; a ordem não importa

Descrição¶

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

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

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

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

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 substring

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

• n: O comprimento (número de caracteres) da substring 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 personagens.

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

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 uma matriz de valores decodificados. Os valores são marcados para que possam ser recuperados por índice ou por nome de campo.

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

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 incorporadas não têm escape.

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 colocada entre aspas simples

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

Parâmetros Opcionais¶

• var1...varN: Um ou mais nomes de variáveis, para corresponder às subexpressões marcadas da expressão

Descrição¶

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

Retorna o número total de subexpressões marcadas (que pode ser maior ou menor que o número de variáveis realmente fornecidas). Quaisquer correspondências adicionais que excedam o número de variáveis fornecidas serã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 da expressão regular 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) intermediário.

Veja também o RegExReplace função.

Exemplos¶

result = RegExMatch("[abc]", "(\\[)(.*)(\\])", "dummy", "value");
// Sets the global variable "$dummy" to "[".
// Sets the global variable "$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 substrings correspondentes substituídas

• exp: A expressão regular na sintaxe da biblioteca de expressões regulares Boost a ser usado para corresponder às substrings da string

• format: Uma string de formato na Boost-Extended Format String Syntax

Descrição¶

Substitui todas as subsequências em uma sequência que corresponde a uma expressão, usando um formato especificado para substituir cada subsequência. Quaisquer seções da string que não correspondam à expressão serão passadas inalteradas para a string retornada.

A expressão regular segue a sintaxe da biblioteca de expressões regulares Boost. É uma variação da sintaxe da expressão regular 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) intermediário.

A string de formato segue a Sintaxe da string de formato Boost-Extended. Se a string de formato for uma string vazia (""), então uma correspondência não produz nenhum resultado para essa substring.

Veja também o RegExMatch função.

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 as substrings correspondentes substituídas

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

• new: Uma string a ser usada como substituto para quaisquer correspondências encontradas

Descrição¶

Pesquisa uma string por substrings que correspondam ao argumento "antigo" e substitui uma substring correspondente pelo argumento "novo".

Para operações de pesquisa e substituição mais complexas, consulte o RegExReplace função.

Exemplos¶

Replace("Monday Tuesday", "day", "day night,");
// Returns "Monday night, Tuesday night,"

Right¶

Declaração¶

string Right(string str, int n)

Sintaxe¶

Right(<str>, <n>)

Parâmetros Obrigatórios¶

• str: Uma linha

• n: O número de caracteres da extremidade direita a serem retornados

Descrição¶

Devoluções n caracteres de uma string, contando a partir da direita (final) de uma string.

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

Exemplos¶

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

RPad¶

Declaração¶

string RPad(string s, int n)

Sintaxe¶

string RPad(string s, int n)

Parâmetros Obrigatórios¶

• str: Uma linha

• n: O número de caracteres da extremidade direita a serem retornados

Descrição¶

Adiciona espaços à direita (final) de uma string até que a string contenha n personagens. Sequências contendo n ou mais caracteres são truncados para n personagens.

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

Exemplos¶

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

RPadChar¶

Declaração¶

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

Sintaxe¶

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

Parâmetros Obrigatórios¶

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

Descrição¶

Adiciona um caractere de preenchimento à direita (final) de uma string até que a string contenha n personagens. Sequências contendo n ou mais caracteres são truncados para n personagens.

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

Exemplos¶

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

RTrim¶

Declaração¶

string RTrim(string str)

Sintaxe¶

RTrim(<str>)

Parâmetros Obrigatórios¶

• str: Uma linha

Descrição¶

Remove espaços em branco (espaços, tabulações) à direita (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 da direita (final)**
  
• trimChars:** Uma sequência de caracteres de corte a serem correspondidos; a ordem não importa

Descrição¶

Remove quaisquer caracteres finais de 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 isso acontecer, ele será removido e o processo será repetido até que não haja mais correspondência.

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

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

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 a divisão entre cada elemento da matriz

Descrição¶

Divide uma string usando uma string delimitadora, retornando o resultado como uma matriz.

Retorna o resultado em uma matriz de tamanho igual ao número de delimitadores mais um. Se a expressão terminar com o delimitador, o tamanho do array será igual ao número de delimitadores (o último valor vazio será ignorado). Se a string não contiver delimitadores, uma matriz de tamanho um será retornada 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") para um único número 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 a divisão entre cada elemento da matriz
• qualifier: Uma string a ser correspondida como a divisão entre cada elemento da matriz

Descrição¶

Divide uma string formatada em CSV e retorna uma matriz com os valores de colunas individuais.

Por padrão, o delimitador é uma vírgula (,) e o qualificador de string é uma aspa dupla ("). Isso pode ser alterado especificando o segundo e terceiro 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) Uma matriz

Descrição¶

Retorna o comprimento de uma string.

A função retorna uma matriz se o argumento for uma matriz, com cada elemento da matriz retornada com o comprimento do elemento correspondente da matriz de argumentos. O Length A função retorna o comprimento de uma matriz 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 linha

Descrição¶

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

Exemplos¶

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

ToProper¶

Declaração¶

string ToProper(string str)

Sintaxe¶

ToProper(<str>)

Parâmetros Obrigatórios¶

• str: Uma linha

Descrição¶

Converte uma string para maiúsculas e minúsculas (a primeira letra de cada palavra é maiúscula). Isso é diferente da caixa do título, que apenas coloca em maiúscula 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 linha

Descrição¶

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

Exemplos¶

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

Trim¶

Declaração¶

string Trim(string str)

Sintaxe¶

Trim(<str>)

Parâmetros Obrigatórios¶

• str: Uma linha

Descrição¶

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

Exemplos¶

Trim(" Hello World! ");
// Returns "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 sequência 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 aos caracteres de corte e retorna os caracteres restantes.

Esta função testa cada caractere inicial e final de uma string e verifica se ele é encontrado nos caracteres de corte. Se isso acontecer, ele será removido e o processo será repetido até que não haja mais correspondências.

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

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

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 linha
• firstChars: O número de caracteres a serem excluídos da esquerda (início) da string
• lastChars: O número de caracteres a serem excluídos da direita (final) da string

Descrição¶

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

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

Exemplos¶

Truncate("a,b,c,", 2, 1);
// Returns "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¶

Analise uma string de URL e retorne o valor decodificado do parâmetro de URL com o nome especificado. O caso do nome é ignorado. Se o nome não for encontrado nos parâmetros da URL, uma string vazia ("") é retornado.

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

Exemplos¶

url = "http://hostname/user?email=john1990%40gmail.com&name=John%20Smith";
URLDecode(url, "name");
// Returns "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 da RFC 1738

Parâmetros Opcionais¶

• encodingOption: Um número inteiro (0 - 3) que especifica a codificação a ser usada. 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 de URL padrão. 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 codifique caracteres "inseguros": " \< ;> ; # % { } | \ ^ \~ [ ] ` and the space character
• 2: Don't encode "reserved" characters: ; / ? : @ & =
• 3: Don't encode "unsafe" characters and "reserved" characters

These characters are considered "safe" and are never encoded: $ - _. + ! * ' ( ) ,

See also the Analisar URL and Funções 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