Explore the guide

DbSeek( <xChave>, [lSoftSeek], [lFindLast] )

DbSeek

Pesquisa uma chave no índice ativo da tabela.

Banco de dadosPesquisa

DbSetOrder

DbSetOrder( <nOrdem> )

Define a ordem de índice usada na área atual.

Banco de dadosÍndice

RecLock( <cAlias>, <lAdiciona> )

RecLock

Bloqueia um registro para inclusão ou alteração.

Banco de dadosGravação

MsUnlock

MsUnlock()

Libera o bloqueio do registro em edição.

Banco de dadosGravação

FWFormModel():New( <cId> )

FWFormModel

Data model used by Protheus MVC routines.

MVCInterface

FWRest():New( <cBaseURL> )

FWFormView

FWFormView():New()

Defines the presentation layer of a Protheus MVC routine.

MVCInterface

↗Classe

FWRest

Cliente para consumo de serviços HTTP REST.

IntegraçãoHTTP

↗Classe

FWMBrowse

FWMBrowse():New()

Constrói e controla browses no Framework do Protheus.

MVCInterface

Help( cRotina, nLinha, cCampo, cNome, cMensagem, ... )

Help

Exibe ajuda contextual para campos e validações.

InterfaceValidação

CTOD

CTOD( <cData> )

Converte uma data em formato caractere para o tipo data.

ConversãoData

CValToChar

CValToChar( <xValor> )

Converte um valor para sua representação em caracteres.

ConversãoCaractere

DToC

DToC( <dData> )

Converte uma data para uma representação em caracteres.

ConversãoData

↗Function

DToS

DToS( <dData> )

Converts a date to text in YYYYMMDD format.

ConversionDate

SToD( <cDataAAAAMMDD> )

SToD

Converte um texto no formato AAAAMMDD para o tipo data.

ConversãoData

Str( <nValor>, [nTamanho], [nDecimais] )

Str

Converte um número em uma cadeia de caracteres.

ConversãoNumérico

StrZero( <nValor>, <nTamanho>, [nDecimais] )

StrZero

Converte um número em texto preenchido com zeros à esquerda.

ConversãoNumérico

MsgAlert( <cTexto>, <cTitulo> ) --> Nil

Val

Val( <cValor> )

Converte uma representação em caracteres para valor numérico.

ConversãoNumérico

↗Function

MsgAlert

Displays an alert message with a title, visual icon and OK button.

InterfaceMessageAlertUser experience

↗Fundamento

A linguagem AdvPL

Advanced Protheus Language

Origem, conceitos e evolução do ambiente de desenvolvimento AdvPL.

IntroduçãoHistória

↗Fundamento

Operadores AdvPL

+ - * / == .And. := & @

Operadores matemáticos, relacionais, lógicos, de atribuição e especiais.

OperadoresSintaxe

↗Fundamento

Escopo de variáveis

Local · Static · Private · Public

Visibilidade e duração das variáveis em programas AdvPL.

VariáveisEscopo

OperatorsExpressionsVariables

Macro substitution

&cExpressao

Evaluates an AdvPL expression stored as text at runtime.

#Include "<arquivo>.ch"

Protheus include files

Understand the role of .ch files and choose the appropriate include for each context.

CompilationConfigurationSyntax

COMANDO <obrigatório> [opcional]

AdvPL syntax notation and conventions

Understand the symbols and patterns used to document AdvPL commands and functions.

SyntaxCommandsDocumentation

FOR <variável> := <inicial> TO <final> [STEP <incremento>] ... NEXT

FOR ... NEXT

Repeats a block of commands a determined number of times using a variable as a counter.

IterationControl flowCommands

IF <expressão lógica> ... [ELSEIF <expressão>] ... [ELSE ...] ENDIF

IF ... ENDIF

Executes a block of commands according to the result of a logical expression.

DecisionControl flowCommands

DO CASE ... CASE <expressão lógica> ... [OTHERWISE ...] ENDCASE

DO CASE ... ENDCASE

Selects and executes the first block whose CASE expression evaluates to true.

DecisionControl flowCommands

WHILE <expressão lógica> ... ENDDO

WHILE ... ENDDO

Repeats a block of commands while a logical expression remains true.

IterationControl flowCommands

AdvPL · linguagem, dados, interface e integração

Microsiga Protheus SDK

Overview of the Protheus SDK and the main foundations covered by its documentation.

SDKAdvPLProtheusFoundations

SpreadsheetsExcelXMLFramework

FWMsExcelEx

FWMsExcelEx():New()

Generates Excel-compatible XML spreadsheets by writing data directly to the file and using less memory.

Local <variável> As <tipo> · Function <nome>(<parâmetro> As <tipo>) As <tipo>

Data typing in AdvPL

Declare variable, parameter, return, property and method types to make inconsistencies more visible.

Data typesVariablesFunctionsClassesCompilation

{ |[parâmetros]| [expressão1, expressão2, ...] }

Code blocks (CodeBlock)

Create storable anonymous functions, receive parameters and evaluate expressions on demand with Eval().

CodeBlockCode blocksEvalAnonymous functionsExpressions

aMatriz := { <elemento1>, <elemento2>, ... } · aMatriz[nÍndice]

Arrays in AdvPL

Organize values in simple or multidimensional lists, access positions and change the structure dynamically.

ArraysCollectionsData structuresMemory

DEFINE ... · @ ... SAY · @ ... GET · @ ... BUTTON · ACTIVATE ...

Visual components in AdvPL

Understand how visual commands provide readable syntax for instantiating and configuring interface classes.

Visual interfaceComponentsCommandsClassesDialogs

@ <nRow>, <nCol> BITMAP [<oBmp>] [RESOURCE <cResName> | FILE <cFileName>] [SIZE <nWidth>, <nHeight>] [OF <oWnd>] [PIXEL]

@ ... BITMAP

Displays an image in an AdvPL interface from a repository resource or a disk file.

Visual interfaceImageBitmapTBitmapCommands

Visual interfaceBrowseTCBrowseTablesArraysCommands

@ ... BROWSE

@ <nRow>, <nCol> [COLUMN] BROWSE <oBrw> [FIELDS <campos>] [ALIAS <cAlias>] [SIZE <nWidth>, <nHeight>] [OF <oDlg>] [PIXEL]

Creates a TCBrowse component for navigating and displaying table or array data.

TCBrowse():New( <nTop>, <nLeft>, <nBottom>, <nRight>, <oWnd>, ... ) --> oBrowse

TCBrowse

Visual class used to display and navigate data in a grid/browse format.

Visual interfaceClassBrowseGridTablesArrays

@ <nRow>, <nCol> CHECKBOX [<oCheckBox> VAR] <lVar> [PROMPT <cCaption>] [OF <oWnd>] [SIZE <nWidth>, <nHeight>] [PIXEL]

@ ... CHECKBOX

Creates a checkbox bound to a logical variable and optionally exposes its TCheckBox object.

Visual interfaceCheckBoxTCheckBoxLogicalCommands

Visual interfaceFolderTFolderTabsContainersCommands

@ ... FOLDER

@ <nRow>, <nCol> FOLDER <oFolder> [OF <oWnd>] [PROMPTS <cItem,...>] [OPTION <nOption>] [SIZE <nWidth>, <nHeight>] [PIXEL]

Creates a tabbed TFolder container for organizing visual components in one interface.

Visual interfaceGETTGetData inputValidationCommands

@ ... GET

@ <nRow>, <nCol> GET [<oGet> VAR] <uVar> [OF <oWnd>] [PICTURE <cPict>] [VALID <cbValid>] [WHEN <cbWhen>] [READONLY] [PASSWORD]

Creates a TGet field for editing character, numeric or date values in an AdvPL interface.

Visual interfaceGETMultilineTMultiGetTextCommands

@ ... GET MULTILINE

@ <nRow>, <nCol> GET [<oMultiGet> VAR] <uVar> MULTILINE [OF <oWnd>] [SIZE <nWidth>, <nHeight>] [WHEN <cbWhen>] [VALID <cbValid>] [READONLY] [NOBORDER] [NO VSCROLL]

Creates a TMultiGet field for editing or displaying multiple lines of text.

Visual interfaceGroupTGroupVisual groupingLayoutCommands

@ ... GROUP

@ <nTop>, <nLeft> GROUP <oGroup> TO <nBottom>, <nRight> [LABEL <cLabel>] [OF <oWnd>] [COLOR <nClrText>, <nClrBack>] [PIXEL]

Draws a TGroup frame with an optional title to visually organize controls.

Visual interfaceMSPanelTPanelContainersLayoutCommands

@ ... MSPANEL

@ <nRow>, <nCol> MSPANEL <oPanel> [PROMPT <cPrompt>] [OF <oWnd>] [FONT <oFont>] [CENTERED] [COLORS <nClrText>, <nClrBack>] [SIZE <nWidth>, <nHeight>] [LOWERED | RAISED]

Creates a TPanel container that organizes and hosts other visual components.