Name

String Function

Syntax

String(number, character)
number

Use: Required

Data Subtype: Long

The length of the required string.

character

Use: Required

Data Subtype: Variant

Character or character code used to create the required string.

Return Value

A Variant of subtype string made up of character, repeated number times.

Description

Creates a string comprising a specified single character repeated a specified number of times.

Rules at a Glance

  • If number contains Null, Null is returned.

  • If character contains Null, Null is returned.

  • character can be specified as a string or as an ANSI character code. For example:

    strBuffer1 = String(128, "=")     ' Fill with "="
    strBuffer2 = String(128, 0)       ' Fill with Chr$(0)
  • If character consists of multiple characters, only the first character is used, and the remainder are discarded.

Programming Tips & Gotchas

  • The String function is useful for creating long strings of _, -, or = characters to create horizontal lines for delimiting sections of a report.

VB/VBA Differences

VBScript does not support the VBA string$ function, which returns a string rather than aVariant of Subtype string.

Get VBScript in a Nutshell now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.