Copia um arquivo do servidor para o client (SmartClient HTML).
O arquivo é copiado para uma pasta temporária no servidor Web e esta pasta é deletada quando aquela sessão é finalizada.
Sintaxe
CpyS2TW( < cOrigem >, [ lSendToBrowser ] )
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Referência |
---|---|---|---|---|
cOrigem | caractere | Indica o nome do arquivo que será copiado. | X | |
lSendToBrowser | lógico | Indica se, falso (.F.), o arquivo será apenas copiado ou se, verdadeiro (.T.), será copiado e enviado para o browser. Conteúdo padrão é verdadeiro (.T.). |
Retorno
Nome | Tipo | Descrição |
---|---|---|
nRet | numérico | Retorna 0 se o arquivo for copiado com sucesso e diferente de 0 se houver falhar na cópia. Para mais informações dos códigos de falha, consulte a área Observações. |
Observações
Códigos de Retorno
0 | Sucesso na cópia. |
---|---|
-1 | Diretório não é um diretório no servidor. |
-2 | Arquivo não existe no servidor. |
-3 | Falha na transmissão para o Servidor Web (SmartClient HTML). |
-4 | Falha na transmissão para o Client Web (navegador de internet). |
- Esta função está disponível somente para o SmartClient HTML.
- Função disponível para build superior a 7.00.100812P.
- Função não pode ser chamada em JOB.
- A partir da build 7.00.120420A, caso a função seja chamada em JOB, o programa será finalizado com ocorrência de erro fatal (Function CpyS2TW doesn't available in JOB.).
- Nas builds anteriores, caso fosse chamada em JOB, a função não era executada e não gerava mensagem de advertência ou ocorrência de erro.
Exemplos
#include "TOTVS.CH" User Function exemplo() Local nRet := CpyS2TW("/spool/x.txt", .T.) If (nRet == 0) conout("Arquivo enviado para download com sucesso") Else conout("Falha na copia") EndIf Return
Abrangência
Protheus 10 , TOTVS Application Server 10 , ByYou Application Server