TOTVSTEC

Árvore de páginas

Adiciona caracteres de preenchimento à direita do conteúdo de uma variável.

Sintaxe

Pad( < xExp >, < nLen >, [ cFill ] )

Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

xExp

qualquer

Indica um valor no qual serão inseridos caracteres de preenchimento.

X

 

nLen

numérico

Indica o tamanho da string que será retornada.

X

 

cFill

caractere

Indica o caractere que será inserido no parâmetro.

 

 

Retorno

Nome

Tipo

Descrição

cRet

caractere

Retorna uma string com o tamanho indicado em nLen contendo o valor indicado em xExp preenchido à direita com o caractere indicado em cFill.

Observações

  • Pad transforma o valor apontado por xExp em string (igual ao comportamento da função cValToChar), e adiciona o caractere definido em cFill à direita do valor de xExp até que o comprimento especificado em nLen seja atingido.
  • Caso o comprimento de xExp convertido para string for maior que o especificado em nLen, a função retornará o conteúdo de xExp truncado, de forma que o seu comprimento final seja igual ao definido em nLen.
  • Caso cFill não seja especificado, o padrão é o espaço em branco (" ").
  • A função utilizará apenas o primeiro caractere da string apontada por cFill.
  • Caso a nLen seja menor ou igual a 0 (zero), a função retornará uma string vazia ("").
  • Essa função tem o mesmo comportamento da função PadR, que é muito útil para a apresentação de dados, através de uma string, dentro de uma área de determinado comprimento. Ela é normalmente utilizada para se obter alinhamento dos dados que serão apresentados pelas funções do AdvPL na tela ou na impressora.
  • A função RTrim é o inverso da função Pad.

Exemplos

Exemplo 1
#define CRLF Chr(13)+Chr(10)
user function mypad()
  Local cMsg := ""
  
  cMsg += ( 'Pad( "Light", 9 ) --- "' + Pad( "Light", 9 ) + '"' + CRLF )
  cMsg += ( 'Pad( "Light", 9, "@" ) --- "' + Pad( "Light", 9, "@" ) + '"' + CRLF )
  cMsg += ( 'Pad( "Light", 9, "@%" ) --- "' + Pad( "Light", 9, "@%" ) + '"' + CRLF )
  cMsg += ( 'Pad( "Light", 3 ) --- "' + Pad( "Light", 3 ) + '"' + CRLF )
  cMsg += ( 'Pad( .T., 9 ) --- "' + Pad( .T., 9 ) + '"' + CRLF )
  cMsg += ( 'Pad( 123, 9 ) --- "' + Pad( 123, 9 ) + '"' + CRLF )

return MsgInfo( cMsg, "Pad Example" )

Resultado do Exemplo

Abrangência

Todas as versões

Veja também

  • Sem rótulos