Páginas filhas
  • FWSX3Util

Classe responsável pelo acesso ao dicionário SX3.


Métodos:


GetDescription()
Sintaxe:
FWSX3Util():GetDescription( cField ) → cDesc

Descrição:
Retorna a descrição de um campo no SX3.

Parâmetros:

NomeTipoDescriçãoObrigatório
cField CaracterNome do campoX


Retorno:
cDesc - String - Descrição do campo na SX3



GetAllFields()
Sintaxe:

FWSX3Util():GetAllFields( cAlias , lVirtual ) → aFields

Descrição:
Retorna os campos de um alias específico da SX3.

Parâmetros:

NomeTipoDescriçãoObrigatório
cAliasCaracterAlias da tabela que os campos serão retornadosX
lVirtualLógico

Indica se também serão retornados os campos virtuais, parâmetro opcional com valor padrão verdadeiro



Retorno:
aFields - Array com os campos da SX3



GetAllGroupFields()
Sintaxe:
FWSX3Util():GetAllGroupFields( cSXGGroup ) → aFields

Descrição:
Responsável por retornar todos os campos de um grupo de campos

Parâmetros:

NomeTipoDescriçãoObrigatório
cSXGGroupCaracterNome do grupo de camposX


Retorno:
aFields - Array contendo os campos do grupo de campos

Exemplo:
aFields := FWSX3Util():GetAllGroupFields( "033" )

Informação:
Antes de retornar os campos presentes em um grupo da SXG, o grupo é verificado na própria SXG. Na inexistência do grupo de campos informado na SXG, nenhum campo será retornado.



GetFieldType()
Sintaxe:
FWSX3Util():GetFieldType( cField ) → cType

Descrição:
Retorna o tipo do campo no SX3 ou vazio quando não encontra o campo

Parâmetros:

NomeTipoDescriçãoObrigatório
cField CaracterCódigo do campo para a busca do tipoX


Retorno:
cType - Caracter - Tipo do campo no SX3 (C,L,D,M,N)



GetFieldStruct()
Sintaxe:
FWSX3Util():GetFieldStruct( cField ) → aStruct

Descrição:
Retorna um array com os dados da estrutura do campo na SX3

Parâmetros:

NomeTipoDescriçãoObrigatório
cField CaracterNome do campo para a buscaX


Retorno:
aStruct - Array - Contém a estrutura do campo presente na SX3

[1] - Nome do campo
[2] - Tipo do campo
[3] - Tamanho do campo
[4] - Decimais do campo 
[5] - Picture do campo

Informação:
Método presente na versão 20190131 da LIB ou superior



GetListFieldsStruct()
Sintaxe:

FWSX3Util():GetListFieldsStruct( cAlias , lVirtual, lRequired ) → aStruct

Descrição:
Retorna um array contendo a estrutura dos campos de um alias específico da SX3.

Parâmetros:

NomeTipoDescriçãoObrigatórioDefault
cAliasCaracterAlias da tabela que os campos serão retornadosX
lVirtualLógico

Indica se também serão retornados os campos virtuais

X
lRequiredLógico

Indica se retorna somente campos obrigatórios


.F.


Retorno:
aStruct - Array - Contém a estrutura dos campos da SX3

[1][1] - Nome do campo
[1][2] - Tipo do campo
[1][3] - Tamanho do campo
[1][4] - Decimais do campo
[1][5] - Picture do campo

Informação:
Método presente na versão 20191122 da LIB ou superior