Guia de Referência do Net.Data

Funções Gerais

Estas são as funções para fins gerais que você pode utilizar:

DTW_ADDQUOTE
DTW_DATE
DTW_GETENV
DTW_GETINIDATA
DTW_HTMLENCODE
DTW_QHTMLENCODE
DTW_SETENV
DTW_TIME
DTW_URLESCSEQ

DTW_ADDQUOTE

Objetivo

AIX HP-UX OS/2 OS/390 OS/400 SCO SUN Win NT
X X X X X X X X

Substitui aspas simples em uma cadeia de entrada com duas aspas simples. Isto é necessário para que instruções SQL sejam concluídas com sucesso caso uma cadeia possua uma aspa simples.

Sintaxe

@DTW_ADDQUOTE(entradaCadeia, saídaCadeia)
@DTW_rADDQUOTE(entradaCadeia)
@DTW_mADDQUOTE(multCadeia, multCadeia2, ..., multCadeian)

Parâmetros

Tabela 1. Parâmetros DTW_ADDQUOTE

Tipo de Dados Parâmetro Uso Descrição
cadeia entradaCadeia IN Variável ou cadeia literal. DTW_mADDQUOTE pode possuir diversas cadeias de entrada.
cadeia saídaCadeia OUT Variável que contém o formato modificado de entradaCadeia.
cadeia multCadeia INOUT

Na entrada: Variável que contém uma cadeia.
Na saída: Variável contendo a cadeia de entrada com cada caractere de aspa simples (') substituído por dois caracteres de aspa simples.

Tipo de Dados	Parâmetro	Uso	Descrição
cadeia	`entradaCadeia`	IN	Variável ou cadeia literal. DTW_mADDQUOTE pode possuir diversas cadeias de entrada.
cadeia	`saídaCadeia`	OUT	Variável que contém o formato modificado de entradaCadeia.
cadeia	`multCadeia`	INOUT	Na entrada: Variável que contém uma cadeia. Na saída: Variável contendo a cadeia de entrada com cada caractere de aspa simples (') substituído por dois caracteres de aspa simples.

Exemplos

Exemplo 1:

@DTW_ADDQUOTE(cadeia1,cadeia2)

Entrada: cadeia1 = "Web page de João"
Retorna: cadeia2 = "Web page de João"

Exemplo 2:

@DTW_rADDQUOTE("O título do
artigo é 'Once upon a time'")

Retorna: O título do artigo é ''Once upon a time''

Exemplo 3:

@DTW_mADDQUOTE(cadeia1,cadeia2)

Entrada: cadeia1="Bolsa de João", cadeia2="'ser ou não ser'"
Retorna: cadeia1="Bolsa de João" cadeia2="''ser ou não ser'"

DTW_DATE

Objetivo

AIX HP-UX OS/2 OS/390 OS/400 SCO SUN Win NT
X X X X X X X X

Retorna a atual data do sistema no formato especificado.

Sintaxe

@DTW_DATE(formato, saídaCadeia)
@DTW_DATE(saídaCadeia)
@DTW_rDATE(formato)
@DTW_rDate()

Parâmetros

Tabela 2. Parâmetros DTW_DATE

Tipo de Dados Parâmetro Uso Descrição
cadeia formato IN Variável ou cadeia literal especificando o formato dos dados. Formatos válidos incluem:

D--Dia do ano (001-366)
E--Formato de data europeu (dd/mm/aa)
N--Formato de data normal (dd mes aaaa)
O--Formato de data ordenado (aa/mm/dd)
S--Formato de data padrão (aaaammdd)
U--Formato de data dos EUA (mm/dd/aa)

O padrão é N.
cadeia saídaCadeia OUT Variável que contém a data no formato especificado.

Tipo de Dados	Parâmetro	Uso	Descrição
cadeia	`formato`	IN	Variável ou cadeia literal especificando o formato dos dados. Formatos válidos incluem: D--Dia do ano (001-366) E--Formato de data europeu (dd/mm/aa) N--Formato de data normal (dd mes aaaa) O--Formato de data ordenado (aa/mm/dd) S--Formato de data padrão (aaaammdd) U--Formato de data dos EUA (mm/dd/aa) O padrão é N.
cadeia	`saídaCadeia`	OUT	Variável que contém a data no formato especificado.

Exemplos

Exemplo 1:

@DTW_DATE(resultados)

Retorna: resultados = "25 Apr 1997"

Exemplo 2:

@DTW_DATE("E",
resultados)

Retorna: resultados="25/04/97"

Exemplo 3:

%HTML(relatório){
<P>Este relatório foi criado em @DTW_rDATE("U").

Retorna: 04/25/97

DTW_GETENV

Objetivo

AIX HP-UX OS/2 OS/390 OS/400 SCO SUN Win NT
X X X X X X X X

Retorna o valor da variável de ambiente especificada. Você também pode utilizar ENVVAR para obter os valores das variáveis de ambiente. Para obter mais informações, consulte Instrução ENVVAR.

Sintaxe

@DTW_GETENV(nomeVarAmb, valorVarAmb)
@DTW_rGETENV(nomeVarAmb)

Parâmetros

Tabela 3. Parâmetros DTW_GETENV

Tipo de Dados Parâmetro Uso Descrição
cadeia nomeVarAmb IN Variável ou cadeia literal.
cadeia valorVarAmb OUT O valor da variável de ambiente especificada em envVarName. Uma cadeia vazia é retornada caso o valor não seja encontrado.

Tipo de Dados	Parâmetro	Uso	Descrição
cadeia	`nomeVarAmb`	IN	Variável ou cadeia literal.
cadeia	`valorVarAmb`	OUT	O valor da variável de ambiente especificada em envVarName. Uma cadeia vazia é retornada caso o valor não seja encontrado.

Exemplos

Exemplo 1:

@DTW_GETENV(meuNomeVarAmb, meuValorVarAmb)

Entrada: meuNomeVarAmb = "PATH"
Retorna: meuValorVarAmb = "/usr/path"

Exemplo 2:

@DTW_rGETENV(meuCaminho)

Entrada: meuCaminho = "PATH"
Retorna: "/usr/path"

Exemplo 3:

O servidor é @DTW_rGETENV("SERVER_NAME").

Retorna: "www.software.ibm.com"

DTW_GETINIDATA

Objetivo

AIX HP-UX OS/2 OS/390 OS/400 SCO SUN Win NT
X X X X X X X X

Retorna o valor da variável de configuração especificada. Caso um valor não seja encontrado, uma cadeia vazia será retornada.
Nota: Variáveis de caminho de configuração especiais, MACRO_PATH, EXEC_PATH e INCLUDE_PATH, assim como instruções ENVIRONMENT não podem ser recuperadas com esta chamada.

Sintaxe

@DTW_GETINIDATA(nomeVarIni, valorVarIni)
@DTW_rGETINIDATA(nomeVarIni)

Parâmetros

Tabela 4. Parâmetros DTW_GETINIDATA

Tipo de Dados Parâmetro Uso Descrição
cadeia nomeVarIni IN Variável ou cadeia literal.
cadeia valorVarIni OUT O valor da variável de configuração especificado em iniVarName.

Tipo de Dados	Parâmetro	Uso	Descrição
cadeia	`nomeVarIni`	IN	Variável ou cadeia literal.
cadeia	`valorVarIni`	OUT	O valor da variável de configuração especificado em iniVarName.

Exemplos

Exemplo 1:

@DTW_GETINIDATA(meuNomeVarAmb, meuValorVarAmb)

Entrada: meuNomeVarAmb = "FFI_PATH"
Retorna: meuValorVarAmb = "D:\FFI"

Exemplo 2:

@DTW_rGETINIDATA("HTTP_COOKIE")

Retorna: "cookie.txt"

DTW_HTMLENCODE

Objetivo

AIX HP-UX OS/2 OS/390 OS/400 SCO SUN Win NT
X X X X X X X X

Caracteres codificados utilizando códigos padrões de escape decimais HTML para muitos, mas não todos, os caracteres. Você pode utilizar esta função para codificar dados que não deseja que o navegador interprete como HTML. Por exemplo, ao utilizar o caractere de escape apropriado, você pode exibir sinais menor que (<) e maior que (>), que geralmente são reservados para tags HTML.

Em um segundo exemplo, a cadeia

"1    2     3"

em HTML mostra somente um espaço entre cada número. Utilize DTW_HTMLENCODE para garantir que o número certo de espaços será exibido.

Os seguintes caracteres são codificados pela função DTW_HTMLENCODE:

Tabela 5. Caracteres de escape decimais HTML

Caractere Nome Código
ESPAÇO Espaço  
" Aspas duplas "
# Sinal de número #
% Percentual %
& "e" comercial &
/ Barra invertida \
: Vírgula :
; Ponto-e-vírgula ;
< Menos que <
= Igual &#61:
> Maior que &#62:
? Ponto-de-interrogação &#63:
@ Sinal de arroba @
[ Parêntese esquerdo (
\ Traço oblíquo\barra /
] Parêntese direito )
^ Acento circunflexo ^
{ Colchete esquerdo {
| Linha direta |
} Colchete direito }
~ Til ~

Sintaxe

@DTW_HTMLENCODE(entradaCadeia, saídaCadeia)
@DTW_rHTMLENCODE(entradaCadeia)

Parâmetros

Tabela 6. Parâmetros DTW_HTMLENCODE

Tipo de Dados Parâmetro Uso Descrição
cadeia entradaCadeia IN Variável ou cadeia literal.
cadeia saídaCadeia OUT Variável contendo a cadeia de entrada modificada na qual determinados caracteres foram substituídos pelo codificação de caractere de escape HTML.

Tipo de Dados	Parâmetro	Uso	Descrição
cadeia	`entradaCadeia`	IN	Variável ou cadeia literal.
cadeia	`saídaCadeia`	OUT	Variável contendo a cadeia de entrada modificada na qual determinados caracteres foram substituídos pelo codificação de caractere de escape HTML.

Exemplos

Exemplo 1:

@DTW_HTMLENCODE(cadeia1,cadeia2)

Entrada: cadeia1 = "Jim's dog"
Retorna: cadeia2 = "Jim's dog"

Exemplo 2:

@DTW_rHTMLENCODE("X
<= 10")

Retorna: "X <= 10"

DTW_QHTMLENCODE

Objetivo

AIX HP-UX OS/2 OS/390 OS/400 SCO SUN Win NT
X X X X X X X X

Executa a mesma função do @DTW_HTMLENCODE, mas também codifica o caractere aspa simples (') com . Os caracteres de escape decimais HTML que o DTW_QHTMLENCODE utiliza são exibidos na Tabela 5.

Leve em consideração a utilização desta função para todas as instruções INPUT SQL. Por exemplo, se fornecer O'Brien como sendo um sobrenome, como no seguinte exemplo, a aspa simples poderá fornecer um erro:

INSERT INTO USER1.CUSTABLE (LNAME, FNAME)
VALUES ('O'Brien', 'Patrick')

Utilizando as alterações da função DTW_QHTMLENCODE, a instrução SQL evita o erro:

INSERT INTO USER1.CUSTABLE (LNAME, FNAME)
VALUES ('O&#39;Brien', 'Patrick')

Para obter detalhes, veja o Exemplo 3.

Sintaxe

@DTW_QHTMLENCODE(entradaCadeia, saídaCadeia)
@DTW_rQHTMLENCODE(entradaCadeia)

Parâmetros

Tabela 7. Parâmetros DTW_QHTMLENCODE

Tipo de Dados Parâmetro Uso Descrição
cadeia entradaCadeia IN Variável ou cadeia literal.
cadeia saídaCadeia OUT Variável que contém o formato modificado de entradaCadeia na qual determinados caracteres são substituídos pela codificação de caractere de escape HTML.

Tipo de Dados	Parâmetro	Uso	Descrição
cadeia	`entradaCadeia`	IN	Variável ou cadeia literal.
cadeia	`saídaCadeia`	OUT	Variável que contém o formato modificado de entradaCadeia na qual determinados caracteres são substituídos pela codificação de caractere de escape HTML.

Exemplos

Exemplo 1:

@DTW_QHTMLENCODE(cadeia1,cadeia2)

Entrada: cadeia1 = "Jim's dog"
Retorna: cadeia2 = "Jim's dog"

Exemplo 2:

@DTW_rQHTMLENCODE("John's & Jane's")

Retorna: "John's & Jane's"

Exemplo 3:

%FUNCTION(DTW_SQL) inserirNome(){
INSERT INTO USER2A.SURVEY
(NAME) VALUES '@DTW_rQHTMLENCODE(nomecompleto)'
%}

Entrada: nomecompleto = "Patrick O'Brien"
Retorna: 'Patrick O'Brien'

DTW_SETENV

Objetivo

AIX HP-UX OS/2 OS/390 OS/400 SCO SUN Win NT
X X X X X X X X

Define uma variável de ambiente com um valor especificado e retorna o valor anterior. Uma cadeia vazia é retornada caso nenhum valor anterior seja encontrado.

Sintaxe

@DTW_SETENV(nomeVarAmb, valorVarAmb, valorAnter)
@DTW_rSETENV(nomeVarAmb, valorVarAmb)

Parâmetros

Tabela 8. Parâmetros DTW_SETENV

Tipo de Dados Parâmetro Uso Descrição
cadeia nomeVarAmb IN Variável ou cadeia literal representando a variável de ambiente.
cadeia valorVarAmb OUT Variável ou cadeia literal com o valor para o qual a variável de ambiente está definida.
cadeia valorAnter OUT Variável que contém o valor anterior da variável de ambiente. DTW_rSETENV retorna o valor como o valor de retorno da função.

Tipo de Dados	Parâmetro	Uso	Descrição
cadeia	`nomeVarAmb`	IN	Variável ou cadeia literal representando a variável de ambiente.
cadeia	`valorVarAmb`	OUT	Variável ou cadeia literal com o valor para o qual a variável de ambiente está definida.
cadeia	`valorAnter`	OUT	Variável que contém o valor anterior da variável de ambiente. DTW_rSETENV retorna o valor como o valor de retorno da função.

Exemplos

Exemplo 1:

@DTW_SETENV("PATH",
"meuCaminho", valorAnter)

Entrada: meuCaminho = "meuCaminho"
Retorna: valorAnter = "meuCaminhoAnter"

Exemplo 2:

@DTW_rSETENV("PATH", "meuCaminho")

Entrada: meuCaminho = "meuCaminho"
Retorna: "meuCaminhoAnter", PATH = "meuCaminho"

DTW_TIME

Objetivo

AIX HP-UX OS/2 OS/390 OS/400 SCO SUN Win NT
X X X X X X X X

Retorna a hora atual do sistema no formato especificado.

Sintaxe

@DTW_TIME(entradaCadeia, saídaCadeia)
@DTW_TIME(saídaCadeia)
@DTW_rTIME(entradaCadeia)
@DTW_rTIME()

Parâmetros

Tabela 9. Parâmetros DTW_TIME

Tipo de Dados Parâmetro Uso Descrição
cadeia entradaCadeia IN Variável ou cadeia literal especificando o formato de hora. Formatos válidos são:

C Hora civil (hh:mmAM/PM utilizando um relógio de 12 horas)
L Hora local (hh:mm:ss)
N Hora normal (hh:mm:ss utilizando um relógio de 24 horas)
H Número de horas desde zero hora
M Número de minutos desde zero hora
S Número de segundos desde zero hora

cadeia saídaCadeia OUT Variável que contém a hora no formato especificado.

Tipo de Dados	Parâmetro	Uso	Descrição
cadeia	`entradaCadeia`	IN	Variável ou cadeia literal especificando o formato de hora. Formatos válidos são: C Hora civil (hh:mmAM/PM utilizando um relógio de 12 horas) L Hora local (hh:mm:ss) N Hora normal (hh:mm:ss utilizando um relógio de 24 horas) H Número de horas desde zero hora M Número de minutos desde zero hora S Número de segundos desde zero hora
cadeia	`saídaCadeia`	OUT	Variável que contém a hora no formato especificado.

Exemplos

Exemplo 1:

@DTW_TIME(resultados)

Retorna: resultados = "10:30:53"

Exemplo 2:

@DTW_TIME("C", resultados)

Retorna: resultados = "10:30AM"

Exemplo 3:

@DTW_rTIME("M")

Retorna: "630"

Exemplo 4:

   %REPORT{
<P>Este relatório foi criado às @DTW_rTIME(), @DTW_rDATE().
%}

Retorna: Este relatório foi criado às 15:04:39, 01 Maio de 1997.

DTW_URLESCSEQ

Objetivo

AIX HP-UX OS/2 OS/390 OS/400 SCO SUN Win NT
X X X X X X X X

Substitui caracteres que não são permitidos em uma URL por seus valores de escape. Você deve utilizar esta função para passar qualquer caractere relacionado na Tabela 10 para outro arquivo da macro ou bloco HTML.

Tabela 10. Caracteres não permitidos nas URLs

Caractere Nome Código
ESPAÇO Espaço &#20
" Aspas duplas &#22
# Sinal de número &#23
% Percentual &#25
& "e" comercial &#26
/ Barra invertida &#2F
: Vírgula &#3A
; Ponto-e-vírgula &#3B
< Menos que &#3C
= Igual &#3D
> Maior que &#3E
? Ponto-de-interrogação &#3F
@ Sinal de arroba &#40
[ Parêntese esquerdo &#5B
\ Traço oblíquo\barra &#5C
] Parêntese direito &#5D
^ Acento circunflexo &#5E
{ Colchete esquerdo &#7B
| Linha direta &#7C
} Colchete direito &#7D
~ Til &#7E

Sintaxe

@DTW_URLESCSEQ(entradaCadeia, saídaCadeia)
@DTW_rURLESCSEQ(entradaCadeia)

Parâmetros

Tabela 11. Parâmetros DTW_URLESCSEQ

Tipo de Dados Parâmetro Uso Descrição
cadeia entradaCadeia IN Variável ou cadeia literal.
cadeia saídaCadeia OUT Variável contendo a cadeia de entrada com caracteres que não são permitidos nas URLs substituídos por seus valores de escape hexadecimais.

Tipo de Dados	Parâmetro	Uso	Descrição
cadeia	`entradaCadeia`	IN	Variável ou cadeia literal.
cadeia	`saídaCadeia`	OUT	Variável contendo a cadeia de entrada com caracteres que não são permitidos nas URLs substituídos por seus valores de escape hexadecimais.

Exemplos

Exemplo 1:

@DTW_URLESCSEQ(cadeia1,cadeia2)

Entrada: cadeia1 = "Guys & Dolls"
Retorna: cadeia2 = "Guys%20%26%20Dolls"

Exemplo 2:

@DTW_rURLESCSEQ("Guys & Dolls")

Retorna: "Guys%20%26%20Dolls"

Exemplo 3: Este exemplo utiliza DTW_rURLESCSEQ em um bloco ROW. Quando o usuário da aplicação clica sobre o nome, o nome e o endereço do e-mail são enviados ao bloco de entrada da macro Net.Data fullrpt.mac com os valores codificados como as variáveis nome e email.

     %ROW{
<P><a href="fullRpt.mac/input?name=@DTW_rURLESCSEQ(V1)&email=@DTW_rULRESCSEQ(V2)">
$(V1)</a>
%}

Entrada: V1="Patrick O'Brien", V2="obrien@ibm.com"

Retorna:

<P><a href="fullrpt.mac/input?name=Patrick%20O'Brien&email="obrien%40ibm.com">
Patrick O'Brien</a>

[ Início da Página | Página Anterior | Próxima Página | Tabela de Conteúdos | Índice ]

Caractere	Nome	Código
ESPAÇO	Espaço
"	Aspas duplas	"
#	Sinal de número	#
%	Percentual	%
&	"e" comercial	&
/	Barra invertida	\
:	Vírgula	:
;	Ponto-e-vírgula	;
<	Menos que	<
=	Igual	&#61:
>	Maior que	&#62:
?	Ponto-de-interrogação	&#63:
@	Sinal de arroba	@
[	Parêntese esquerdo	(
\	Traço oblíquo\barra	/
]	Parêntese direito	)
^	Acento circunflexo	^
{	Colchete esquerdo	{
\|	Linha direta	\|
}	Colchete direito	}
~	Til	~