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:
| Nome | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| cField | Caracter | Nome do campo | X |
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:
| Nome | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| cAlias | Caracter | Alias da tabela que os campos serão retornados | X |
| lVirtual | Ló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:
| Nome | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| cSXGGroup | Caracter | Nome do grupo de campos | X |
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:
| Nome | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| cField | Caracter | Código do campo para a busca do tipo | X |
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:
| Nome | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| cField | Caracter | Nome do campo para a busca | X |
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
Informação:
Método presente na versão 20190131 da LIB ou superior
GetListFieldsStruct()
Sintaxe:
FWSX3Util():GetListFieldsStruct( cAlias , lVirtual ) → aStruct
Descrição:
Retorna um array contendo a estrutura dos campos de um alias específico da SX3.
Parâmetros:
| Nome | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| cAlias | Caracter | Alias da tabela que os campos serão retornados | X |
| lVirtual | Lógico | Indica se também serão retornados os campos virtuais | X |
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
Informação:
Método presente na versão 20191122 da LIB ou superior