Page tree
Skip to end of metadata
Go to start of metadata

Disponibilidade

Classe disponível a partir da lib 20180912

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


Métodos:


GetFile()
Sintaxe:
FWSX2Util():GetFile( cAlias ) → cFile

Descrição:
Retorna o arquivo da SX2

Parâmetros:

NomeTipoDescriçãoObrigatório
cAliasCaracterNome do alias da tabelaX

Retorno:
cFile - Caracter - Arquivo da tabela no SX2

Exemplo:
cFile := FWSX2Util():GetFile( "SA1" )


GetPath()
Sintaxe:
FWSX2Util():GetPath( cAlias ) → cPath

Descrição:
Retorna o path da SX2

Parâmetros:

NomeTipoDescriçãoObrigatório
cAliasCaracterNome do alias da tabelaX

Retorno:
cPath - Caracter - Path da tabela na SX2

Exemplo:
cPath := FWSX2Util():GetPath( "SED" )


GetX2Module()
Sintaxe:
FwSX2Util():GetX2Module( cAlias , lSeekByFile ) →  nModule

Descrição:
Recupera o número do módulo da tabela no SX2
Este método está disponível a partir do Label 20190131 da LIB Protheus.

Parâmetros:

Nome

Tipo

Descrição

Obrigatório

cAlias CaracterIndica qual a tabela a ser pesquisadaX
lSeekByFile LógicoDefine se a busca deve acontecer pela coluna X2_ARQUIVO (.T.) ou pela coluna de alias padrão (.F.) | conteúdo default .F.


Retorno: 
nModule - Numérico - Valor do campo X2_MODULO da tabela pesquisada.

Exemplo:
nModSA1 := FwSX2Util(): GetX2Module( "SA1" )
nModSE2 := FwSX2Util(): GetX2Module( "SE2990", .T. ) 



GetX2Name()
Sintaxe:
FwSX2Util():GetX2Name( cAlias , lSeekByFile ) →  cName

Descrição:
Recupera a descrição da tabela no SX2

Parâmetros:

NomeTipoDescriçãoObrigatório
cAlias CaracterIndica qual a tabela a ser pesquisadaX
lSeekByFile LógicoDefine se a busca deve acontecer pela coluna X2_ARQUIVO (.T.) ou pela coluna de alias padrão (.F.) | conteúdo default .F.


Retorno:
cName - Caracter - Valor do campo X2_NAME conforme o idioma do ambiente

Exemplo:
cNameSA1 := FwSX2Util():GetX2Name( "SA1" ) // Deve retornar Clientes
cNameSE2 := FwSX2Util():GetX2Name( "SE2990", .T. ) // Deve retorno títulos a pagar


GetX2SysObj()
Sintaxe:
FwSX2Util():GetX2SysObj(cAlias) → cSysObj

Descrição:
Recupera a informação do campo na tabela SX2

Parâmetros:

NomeTipoDescriçãoObrigatório
cAliasCaracterIndica qual a tabela a ser pesquisadaX


Retorno:
cSysObj - Caracter - Valor do campo X2_SYSOBJ da tabela informada

Exemplo:
cSysObj := FwSX2Util():GetX2SysObj('A03')


GetX2UsrObj()
Sintaxe:
FwSX2Util():GetX2UsrObj(cAlias) → cUsrObj

Descrição:
Recupera a informação do campo na tabela SX2

Parâmetros:

NomeTipoDescriçãoObrigatório
cAliasCaracterIndica qual a tabela a ser pesquisadaX


Retorno:
cUsrObj - Caracter - Valor do campo X2_USROBJ da tabela informada

Exemplo:
cSysObj := FwSX2Util():GetX2UsrObj('SA3')


GetSX2Data()
Sintaxe:
FwSX2Util():GetSX2Data(cAlias, aFields, lQuery) → aReturn

Descrição:
Retorna os campos informados da SX2, podendo retornar todos os campos

Parâmetros:

NomeTipoDescriçãoObrigatório
cAliasCaracterIndica qual a tabela a ser pesquisadaX
aFieldsArrayCampos que serão retornadosX
lQueryLógicoInforma se faz query para retornar os dadosX


Retorno:
aReturn - Array - Campos informados e seus valores

Exemplo:
aReturn:= FwSX2Util():GetSX2data('SA7') // Retorna os campos e valores da tabela informada
aReturn:= FwSX2Util():GetSX2data('SA7', {"X2_UNICO"}) // Retorna apenas o valor do campo informado



SeekX2File()
Sintaxe:
FwSX2Util():SeekX2File( cFile ) → lFound

Descrição:
Posiciona no SX2 conforme o nome físico informado para pesquisa

Parâmetros:

NomeTipoDescriçãoObrigatório
cFile CaracterIndica qual a tabela a ser pesquisada X


Retorno:
lFound - Lógico - Indica se conseguiu posicionar ou não no registro

Exemplo:
lFound := FwSX2Util():SeekX2File( "SE2990" )

  • No labels