FUNçãOEm revisão

SubStr

SubStr( <cString>, <nPosInicial>, [nCaracteres] )

Retorna parte de uma string a partir de uma posição.

StringsExtraçãoTexto

01 · VISÃO GERAL

Visão geral

SubStr() extrai um trecho de texto com base na posição inicial e, opcionalmente, na quantidade de caracteres desejada. É uma das funções mais usadas para tratar campos, códigos compostos e textos delimitados.

02 · SINTAXE

Sintaxe

SubStr( <cString>, <nPosInicial>, [nCaracteres] )

Parâmetros

cString

CaractereObrigatório

Texto de origem.

nPosInicial

NuméricoObrigatório

Posição inicial do trecho, considerando a primeira posição como 1.

nCaracteres

NuméricoOpcional

Quantidade de caracteres retornados. Quando omitida, retorna até o fim do texto.

03 · EXEMPLO PRÁTICO

Extraindo parte de um código

User Function ExSubStr()
    Local cChave := "FIL01PROD0001"
    Local cProduto := SubStr(cChave, 6, 8)

    MsgInfo("Produto: " + cProduto)
Return

Resultado esperado

A função extrai oito caracteres a partir da posição 6.

BOAS PRÁTICAS

Combine com At() e Rat() para extrair trechos delimitados.
Use constantes para posições fixas quando o código representar layout conhecido.

ARMADILHAS COMUNS

Evite posições mágicas sem comentário; elas tornam o fonte difícil de manter.
Valide o tamanho do texto antes de extrair posições obrigatórias.

Conteúdos relacionados

REFERÊNCIAS

Programação em ADVPL Completo. Documentação oficial histórica de treinamento, seção 4.5.4, p. 45-50. Conteúdo resumido, revisado e exemplos adaptados.

Situação: Em revisão
Página criada em: 24/08/2026 às 23:20
Última revisão em: 24/08/2026 às 23:20
Idioma original: Português
Revisão: Usina.BR