SUBSTRC( ) Function

  • Article

Returns a character string from the given character expression or memo field.

SUBSTRC(cExpression, nStartPosition [, nCharactersReturned])

Return Values

Character

Parameters

  • cExpression
    Specifies the character expression or memo field from which the character string is returned.

  • nStartPosition
    Specifies the position in the character expression or memo field cExpression from where the character string is returned. The first character of cExpression is position 1.

    If TALK is set to ON and nStartPosition is greater than the number of characters in cExpression, Visual FoxPro generates an error message. If TALK is set to OFF, the empty string is returned.

  • nCharactersReturned
    Specifies the number of characters to return from cExpression. If you omit nCharactersReturned, characters are returned until the end of the character expression is reached.

Remarks

SUBSTRC( ) is designed for expressions containing double-byte characters. If the expression contains only single-byte characters, SUBSTRC( ) is equivalent to SUBSTR( ).

SUBSTRC( ) returns a character string from the given character expression or memo field. The character expression or memo field can contain any combination of single-byte and double-byte characters.

SUBSTRC( ) will not return a value for a memo field when issued in the Debug window. To return a value in the Debug window, place the memo field name within ALLTRIM( ), and place ALLTRIM( ) within SUBSTRC( ).

This function is useful for manipulating double-byte character sets for languages such as Hiragana and Katakana.

See Also

AT( ) | AT_C( ) | ATC( ) | ATCC( ) | ATCLINE( ) | ATLINE( ) | LEFT( ) | RAT( ) | RATLINE( ) | RIGHT( ) | LEFTC( ) | RIGHTC( ) | SUBSTR( ) | STRTRAN( ) | STUFFC( )