Exibir origem

Não publicar esta página

XFUNVldUni(cAlias, nOrder, cChave, lUpper)

Função de validação da chave única da tabela utilizando EXISTCPO

Parâmetros:

cAlias - Alias da tabela para o EXISTCPO

nOrder - Caso seja necessário alterar a ordem de pesquisa do EXISTCPO

cChave - Deve ser enviado caso seja uma chave diferente do padrão da função, o próprio campo em edição no momento (READVAR)
lUpper - Default converte em Maiúsculas a string de busca, caso utilize case-sensitive envie .F. (False) no parâmetro

Retorno: lOk - Estrutura

.T. - Para validação OK
.F. - Para validação NÃO OK

Exemplo:

XFUNVldUni("C9V", 5, FWFLDGET("C9V_CPF") + DTOS(M->C9V_DTALT))

XFUNVldCmp(cAlias , nOrder , cChave , lID , nOrdID , lVldVig , lVldFin , lVldAtv)

Função de validação utilizando EXISTCPO e chamando o HELP do campo

Parâmetros:

cAlias - Alias da tabela para o EXISTCPO
nOrder - Caso seja necessário alterar a ordem de pesquisa do EXISTCPO
cChave - Deve ser enviado caso seja uma chave diferente do padrão da função, o próprio campo em edição no momento (READVAR)
lID - Tratamento para criar um facilitador de digitação, de forma a aceitar tanto o ID como o código do cadastro (segundo identificador)
nOrdID - Ordem/Índice da tabela para o conceito acima (lId == .T.)
lVldVig - Informa se necessita validação da Data de Vigência
lVldFin - Informa se necessita validação da Data Inicial e Final
lVldAtv - Informa se necessita validação do campo Ativo

Retorno: lOk - Estrutura

.T. - Para validacao OK
.F. - Para validacao NÃO OK

Exemplo:

XFUNVldCmp("C8N",,,,2,.T.)

XFUNVldIE(cIE , cUF , lHelp)

Função de validação do dígito verificador da IE

Parâmetros:

cIE - Código da Inscrição estadual
cUF - Unidade Federativa
lHelp - Indica se o Help deverá ser demonstrado (OPC)

Retorno: lRetorno - Estrutura

.T. - Para validacao OK
.F. - Para validacao NÃO OK

Nome	Tipo	Descrição	Default	Obrigatório
cIE	Caractere	Código da Inscrição estadual		X
cUF	Caractere	Unidade Federativa		X

Exemplo:

XFUNVldIE(M->C1H_IE, FWFLDGET("C1H_UF"))

xFunWizard(aTxtApre, aPaineis, cNomeWizard, cNomeAnt, nTamSay, lBackIni, bFinalExec)

Função de montagem da Wizard da rotina.

Parâmetros:

aTxtApre - Array com o cabeçalho da Wizard
aPaineis - Array com os painéis da Wizard
cNomeWizard - Nome do arquivo da Wizard
cNomeAnt - Nome do arquivo anterior da Wizard, caso tenha mudado de nome
nTamSay - Indica a largura em pixels do objeto
lBackIni - Indica se deve retornar ao início da Wizard
bFinalExec - Bloco de código a ser executado ao final da Wizard

Retorno: lRet - Estrutura

.T. - Para validação OK
.F. - Para validação NÃO OK

Nome	Tipo	Descrição	Default	Obrigatório
aTxtApre	Array	Array com o cabeçalho da Wizard		X
aPaineis	Array	Array com os painéis da Wizard		X
cNomeWizard	Caractere	Nome do arquivo da Wizard		X
cNomeAnt	Caractere	Nome do arquivo anterior da Wizard, caso tenha mudado de nome
nTamSay	Numérico	Indica a largura em pixels do objeto.	0
lBackIni	Lógico	Indica se deve retornar ao inicio da Wizard	.F.
bFinalExec	Bloco de Código	Bloco de código a ser executado ao final da Wizard	Nil

FATXGrvWizard(cNomeWizard , aVarPaineis , aPaineis)

Função para realizar a gravação dos dados inseridos nos objetos no txt (.WIZ)

Parâmetros:

cNomeWizard - Nome do arquivo de Wizard
aVarPaineis - Array com as informações digitadas no Wizard
aPaineis - Array com os painéis do Wizard

Retorno: lRet - Estrutura

.T. - Para validação OK
.F. - Para validação NÃO OK

Nome	Tipo	Descrição	Obrigatório
cNomeWizard	Caractere	Nome do arquivo de Wizard	X
aVarPaineis	Array	Array com as informações digitadas no Wizard	X
aPaineis	Array	Array com os painéis do Wizard	X

xFUNSaveProf(cNomeWizard , aParametros)

Função que salva os parâmetros no profile.

Parâmetros:

cNomeWizard - Nome do arquivo de Wizard
aParametros - Array com o conteúdo dos campos do Wizard para gravação no profile

Retorno: lRet - Estrutura

.T. - Para validação OK
.F. - Para validação NÃO OK

Nome	Tipo	Descrição	Default	Obrigatório
cNomeWizard	Caractere	Nome do arquivo de Wizard		X
aParametros	Array	Array com o conteúdo dos campos do Wizard para gravação no profile		X

XFUNLoadProf(cNomeWizard , aIniWiz)

Função que carrega os parâmetros do profile.

Parâmetros:

cNomeWizard - Nome do arquivo de Wizard
aIniWiz - Array com o conteúdo do arquivo texto do Wizard (Retorno Por Referência)

Retorno: lRet - Estrutura

.T. - Para validação OK
.F. - Para validação NÃO OK

Nome	Tipo	Descrição	Default	Obrigatório
cNomeWizard	Caractere	Nome do arquivo de Wizard		X
aIniWiz	Array	Array com o conteúdo do arquivo texto do Wizard (Retorno Por Referência)		X

XFUNFilSXB(cFilDtVig, cFilDtFin, cTipoModel, cF3Wizard)

Função utilizada nas consultas SXB para personalizar os filtros das informações.

Parâmetros:

cFilDtVig - Data de Vigência
cFilDtFin - Data Final de Vigência
cTipoModel - Informa qual o modelo para registros genericos do ECF
cF3Wizard - Parâmetro usado apenas quando necessário um filtro de F3 vindo da Wizard de Geração de Obrigação Fiscal

Retorno: cRet - Retorna a string do filtro SXB

Nome	Tipo	Descrição
cFilDtVig	Caractere	Data de Vigência
cFilDtFin	Caractere	Data Final de Vigência
cTipoModel	Caractere	Informa qual o modelo para registros genéricos do ECF
cF3Wizard	Caractere	Parâmetro usado apenas quando necessário um filtro de F3 vindo da Wizard de Geração de Obrigação Fiscal

XFUNVldDiv()

Função utilizada na validação da data extemporânea do movimento.

Retorno: lRet - Retorna FLAG de validação

.T. - Para validação OK
.F. - Para validação NÃO OK

XFUNVld( nIndice, lUPPER )

Função utilizada na validação.

Parâmetros:

nIndice - Caso seja necessário alterar a ordem de pesquisa do EXISTCPO
lUPPER - Default converte em Maiúsculas a string de busca, caso utilize case-sensitive envie .F. (False) no parâmetro

Retorno: lRet - Retorna FLAG de validação

.T. - Para validação OK
.F. - Para validação NÃO OK

Nome	Tipo	Descrição	Obrigatório
nIndice	Numérico	Ordem de pesquisa do EXISTCPO
lUPPER	Lógico	Converte em Maiúsculas a string de busca, caso utilize case-sensitive envie .F. (False) no parâmetro

XFUNRedund( cCmpModel )

Função utilizada para validar redundância entre a relação.

Parâmetros:

cCmpModel - Campo a ser validado com o campo editado.

Retorno: lRet

.T. - Para validação OK
.F. - Para validação NÃO OK

Nome	Tipo	Descrição
cCmpModel	Caractere	Campo a ser validado com o campo editado.

Exemplo:

Cadastro de Fator de Conversão, onde seleciona-se uma unidade de medida e cadastra-se as conversões para a mesma. Porém não pode existir a conversão para a mesma UM selecionada.

XFUNTrg( nOpc, cCmpModel, cString )

Função utilizada para retornar valor nos gatilhos.

Parâmetros:

nOpc - Número da opção do tratamento específico.
cCmpModel - Campo a ser validado com o campo editado.
cString - Utilizado para opção 21

Retorno: nValor - Retorna o Valor de retorno para o gatilho.

Nome	Tipo	Descrição
nOpc	Numérico	Número da opção do tratamento específico.
cCmpModel	Caractere	Campo a ser validado com o campo editado.
cString	Caractere	Utilizado para opção 21

xFunRelac( nOpc, cCmpPar, nTpRet, lBrw)

Função utilizada no X3_RELAC.

Parâmetros:

nOpc - Número da opção do tratamento específico.
cCmpPar - Campo a ser validado com o campo editado.
nTpRet - Utilizado para opção 21
lBrw -

Retorno: cValor - Retorna o Valor de retorno para o X3_RELAC

Nome	Tipo	Descrição	Default
nOpc	Numérico	Número da opção do tratamento específico.	999
cCmpPar	Caractere	Campo a ser validado com o campo editado.
nTpRet	Numérico	Número do Tipo de Retorno que deve ser retornado para o X3_RELAC	0
lBrw	Lógico	Define as tabelas que serão geradas	.F.

XFUNVldDt( cCmpModDe, cCmpModAte )

Função utilizada para fazer validação de data e apresentar um help ao usuário.

Parâmetros:

cCmpModDe - Campo de referência para comparação de data (data inicial)
cCmpModAte - Campo de referência para comparação de data (data final)

Retorno: lRet - Estrutura

.T. - Para validação OK
.F. - Para validação NÃO OK

Nome	Tipo	Descrição	Obrigatório
cCmpModDe	Caractere	Campo de referência para comparação de data (data inicial)	X
cCmpModAte	Caractere	Campo de referência para comparação de data (data final)	X

XFUNChgF3( cCampoCond, cModel, cFlag, cIdTrib )

Função utilizada para trocar a consulta F3 em momento de execução dependendo do tributo informado.

Parâmetros:

cCmpCond - Nome do campo do tributo para fazer a validação, o conteúdo é retornado pela clase GetValue ( cModel, cCampoCond )
cModel - Id do modelo para passar na função GetValue ( cModel, cCampoCond )
cFlag - Flag para indicar qual controle de alteração da consulta F3 será validado.
cIdTrib - Id do tributo para retorno da tabela F3, caso não seja passado será utilizado o conteúdo desse campo na Model.

Retorno: cF3 - Retorna o nome da consulta F3 a ser utilizada.

Nome	Tipo	Descrição	Default
cCmpCond	Caractere	Nome do campo do tributo para fazer a validação, o conteúdo é retornado pela clase GetValue ( cModel, cCampoCond )	Default é as 3 primeiras posições do campo que esta sendo editado mais a string "_CODTRI". (Ex: C35_CODTRI)
cModel	Caractere	Id do modelo para passar na função GetValue ( cModel, cCampoCond )	Default é a concatenação da string "MODEL_" mais 3 primeiras posições do campo que esta sendo editado. (Ex: MODEL_C35)
cFlag	Caractere	Flag para indicar qual controle de alteração da consulta F3 será validado.	"TRI"
cIdTrib	Caractere	Id do tributo para retorno da tabela F3, caso não seja passado será utilizado o conteúdo desse campo na Model.

XFUNVldMem( cFlag, cCmpModel, nIndice, cString, lInteg, cAliasMot )

Função genérica de validação do conteúdo do campo em memória diante de uma condição. Apresenta Help padrão.

Parâmetros:

cFlag - Flag para tratamento específico de validação. Default de cFlag é "CST"
cCmpModel - Campo do model para tratamento da validação baseado em outra informação. Este campo será chamado através do FWFLDGET. Default de cCmpModel é o Alias da tabela + "_CODTRI", ex: C35_CODTRI
nIndice - Caso seja necessário alterar a ordem de pesquisa do EXISTCPO.
cString - Usado quando o campo TRIBUTO não existe.
lInteg - Define se a rotina esta sendo chamada via motor/Tafainteg de integração
cAliasMot - Alias usado no motor/TafaInteg de integração

Retorno: xRet - Estrutura

.T. - Para validação OK
.F. - Para validação NÃO OK

Nome	Tipo	Descrição	Default
cFlag	Caractere	Flag para tratamento específico de validação. Default de cFlag é "CST"	CST
cCmpModel	Caractere	Campo do model para tratamento da validação baseado em outra informação. Este campo será chamado através do FWFLDGET. Default de cCmpModel é o Alias da tabela + "_CODTRI", ex: C35_CODTRI	SubStr( cCmp , 1 , 3 ) + "_CODTRI"
nIndice	Numérico	Caso seja necessário alterar a ordem de pesquisa do EXISTCPO.	Nil
cString	Caractere	Usado quando o campo TRIBUTO não existe.
lInteg	Lógico	Define se a rotina esta sendo chamada via motor/Tafainteg de integração	.F.
cAliasMot	Caractere	Alias usado no motor/TafaInteg de integração

XFUNVldCod( cCmpModDe, cCmpModAte )

Função utilizada para fazer validação de Código e apresentar um help ao usuário.

Parâmetros:

cCmpModDe - Campo de referência para comparação de Codigo Inicial
cCmpModDe - Campo de referência para comparação de Codigo Final

Retorno: lRet - Estrutura

.T. - Para validação OK
.F. - Para validação NÃO OK

Nome	Tipo	Descrição	Default	Obrigatório
cCmpModDe	Caractere	Campo de referência para comparação de Codigo Inicial		X
cCmpModAte	Caractere	Campo de referência para comparação de Codigo Final		X

XFUNVldVal( nDec )

Função utilizada para validar conteúdos negativos de campos numéricos e também efetuar a comparação entre o valor informado e o calculado.

Parâmetros:

nDec - Quantidade de decimais a ser tratado no arredondamento.

Retorno: lRet - Estrutura

.T. - Para validação OK
.F. - Para validação NÃO OK

Nome	Tipo	Descrição	Default	Obrigatório
nDec	Numérico	Quantidade de decimais a ser tratado no arredondamento.	2

XFUNPer()

Função utilizada para validar conteúdos de campos de períodos.

Retorno: lRet - Estrutura

.T. - Para validação OK
.F. - Para validação NÃO OK

XFUNMNot( cId )

Função para retornar o modelo da nota fiscal de acordo com o Convenio 31/99.

Parâmetros:

cId - Id do tipo de espécie cadastrado na tabela C01.

Retorno: cEspecie - Espécie da nota fiscal

cEspecie - Espécie da nota fiscal

Nome	Tipo	Descrição	Default	Obrigatório
cId	Caractere	Id do tipo de espécie cadastrado na tabela C01.

XFUNUFID( cUf )

Função para retornar o ID da UF passada por parâmetro ou do MV_TAFUF como DEFAULT.

Parâmetros:

cUf - Unidade Federativa do Estado.

Retorno: cId

cId - Id da Unidade Federativa do Estado cadastrado na tabela C09.

Nome	Tipo	Descrição	Default	Obrigatório
cUf	Caractere	Id da Unidade Federativa do Estado	MV_TAFUF

XFUNCodUF( cCodUF )

Função para retornar a UF mediante o código da propria UF cadastrado na tabela C09.

Parâmetros:

cCodUF - Código da Unidade Federativa do Estado cadastrado na tabela C09.

Retorno: cRet

cRet - Unidade Federativa do Estado.

Nome	Tipo	Descrição	Default	Obrigatório
cCodUF	Caractere	Código da Unidade Federativa do Estado cadastrado na tabela C09.		X

Exemplo: Transforma 35 em SP.

XFUNMnuTAF( cMenu, lCopiar, aFuncao, lMenPadrao, cRetific, cAlterac, cCancFim, lCallMenu )

Função responsável por retornar o MENU padrão das rotinas do TAF.

Parâmetros:

cMenu - Nome da Rotina.
lCopiar - Habilita rotina padrão de Cópia.
aFuncao - Array com rotinas adicionais.
lMenPadrao - Indica se deve carregar os botões padrões do Menu.
cRetific - Título de Retificação do Evento.
cAlterac - Título de Alteração do Evento.
cCancFim - Título de Cancelar\Terminar\Finalizar Operação do Evento.
lCallMenu - Habilita a verificação do fonte\função requisitor desta função, para verificar qual o tipo de pesquisa irá realizar no TAFRotinas.

Retorno: aRotina

aRotina - Array com as opções de Menu.

Nome	Tipo	Descrição	Default	Obrigatório
cMenu	Caractere	Nome da Rotina		X
lCopiar	Lógico	Habilita rotina padrão de Cópia	.F.
aFuncao	Array	Array com rotinas adicionais. Posições do Array: 1 - C - Titulo da Rotina (Caso não esteja disponibilizado no TAFXFUN) 2 - C - Nome da Função a ser executada 3 - C - Título da rotina (Disponibilizado no TAFXFUN)
lMenPadrao	Lógico	Indica se deve carregar os botões padrões do Menu	.T.
cRetific	Caractere	Título de Retificação do Evento.
cAlterac	Caractere	Título de Alteração do Evento.
cCancFim	Caractere	Título de Cancelar\Terminar\Finalizar Operação do Evento.
lCallMenu	Lógico	Habilita a verificação do fonte\função requisitor desta função, para verificar qual o tipo de pesquisa irá realizar no TAFRotinas, se vai usar o cMenu ou o retorno do FunName().	.T.