Daily Archives: February 10, 2014

POSUPPER()

Posted on by vivaclipper

POSUPPER()

Left-most position of an uppercase letter in a string

Syntax

        POSUPPER( <cString>, [<lMode>], [<nIgnore>] )
                      -> nPosition

Arguments

<cString> Designates the string that is searched.

<lMode> Designates how the function searches for the first upper case, alphabetic character. The default value (.F.) searches for the first alphabetic character that would be changed by the Harbour function LOWER().

<nIgnore> Designates the number of characters at the beginning of the character string that are excluded from the search. The default value excludes none (0).

Returns

The value returned corresponds to the position of the character located. When no matching character is found, the function returns 0.

Description

Starting from the beginning of the string, POSUPPER() searches for the first upper case, alphabetic character in the <cString> that corresponds to the first character that would be changed by the Harbour LOWER() function. If <lMode> is .T., the function searches for the first non- alphabetic character that would not be changed by LOWER(). The <nIgnore> parameter can exclude a specific number of characters at the beginning of <cString>.

Notes

. Characters located when the <lMode> parameter is .T. are not necessarily lower case, alphabetic characters. . The function works in conjunction with the NATION module because different languages use different characters to represent their alphabets.

Example

       cString  :=  "123abcUABC"
           ? POSUPPER(cString)                 // Result: 7
           ? POSUPPER(cString, .T.)            // Result: 1
           ? POSUPPER(cString, .F., 7)         // Result: 8

Compliance

POSUPPER() is compatible with CT3’s POSUPPER().

Platforms

All

Files

Source is pos1.c, library is libct.

Seealso

POSALPHA(), POSLOWER(), POSRANGE()

POSREPL()

Posted on by vivaclipper

POSREPL()

Replace characters at a certain position within a string

Syntax

        POSREPL( <[@]cString>, <cReplacement>,
                [<nStartPosition>] ) -> cString

Arguments

<cString> [@] Designates the character string within which the particular characters are replaced.

<cReplacementstring> Designates a sequence of characters that, starting at <nStartPos>, replace a portion of

<cString>. <nStartPos> Designates from which character within <cString> the replacement starts.

Returns

POSREPL() returns the modified string.

Description

When you use POSREPL(), you can replace a range of characters within <cString> with another character string <cReplacementstring>. The new characters are exchanged beginning at <nStartPos>.

Notes

. When the <nStartPos> parameter is not specified, the <cReplacementstring> overwrites the end of the string (see examples). . The return value of this function can be suppressed by implementing CSETREF() to save space in working memory.

Examples

       .  Starting at position 3, replace three characters with "XXX":
              ? POSREPL("ABCDEFG", "XXX", 3)         // "ABXXXFG"
           .  Replace the last LEN(<cReplacementstring>) characters:
              ? POSREPL("ABCDEFG", "XXX")            // "ABCDXXX"
           .  The result can be longer than the character string passed.
              ? POSREPL("ABCDEF", "123", 5)          // "ABCD123"
              ? POSREPL("ABCDEF", "123", 6)          // "ABCDE123"

Compliance

POSREPL() is compatible with CT3’s POSREPL().

Platforms

All

Files

Source is pos2.c, library is libct.

Seealso

POSCHAR(), POSDEL(), POSINS(), CSETREF()

POSRANGE()

Posted on by vivaclipper

POSRANGE()

Left-most position of a character from a set in a string

Syntax

       POSRANGE( <cChar1>, <cChar2>, <cString>, [<lMode>],
                      [<nIgnore>] ) -> nPosition

Arguments

<cCharacter1> and <cCharacter2> Designate the first and the last character of the character range.

<cString> Designates the string within which to search for a character in the <cCharacter1> to <cCharacter2> range.

<lMode> Designates if the return value is within the specified range or outside of the range. The default value (.F.) searches for the first character within the range.

<nIgnore> Designates the number of characters at the beginning of the character string that are excluded from the search. The default value excludes none (zero).

Returns

The value returned corresponds to the position of the located character. If no character is found, the function returns 0.

Description

Beginning from the left, POSRANGE() searches for the first character in the range <cCharacter1> to <cCharacter2> within <cString>. If <lMode> is specified as .T., then the function searches for the first character that is not in the specified range. This way you could search for control characters within a string by specifying <cCharacter1> = CHR(0) and <cCharacter2> = CHR(31). The <nIgnore> parameter gives you the ability to exclude a particular number of characters at the beginning of the <cString> from the search.

Examples

       .  Search for the first character in the character string cInput
              that is not a control character:
              cInput  :=  COM_READ(1)
              ? POSRANGE(CHR(0), CHR(31), cInput, .T.)
           .  Ignore the first 10 characters:
              ? POSRANGE(CHR(0), CHR(31), cInput, .T., 10)

Compliance

POSRANGE() is compatible with CT3’s POSRANGE().

Platforms

All

Files

Source is pos1.c, library is libct.

Seealso

POSALPHA(), POSLOWER(), POSUPPER(), RANGEREPL()

POSLOWER()

Posted on by vivaclipper

POSLOWER()

Left-most position of a lowercase letter in a string

Syntax

       POSLOWER( <cString>, [<lMode>], [<nIgnore>] ) -> nPosition

Arguments

<cString> Designates the string that is searched.

<lMode> Designates how the function searches for the first lower case alphabetic character. The default value (.F.) searches for the first alphabetic character that can be changed by the Harbour function UPPER().

<nIgnore> Designates the number of characters at the beginning of the character string that are excluded from the search. The default value excludes none (0).

Returns

The value returned corresponds to the position of the character located. When no matching character is found, the function returns 0.

Description

Starting from the beginning of the string, POSLOWER() searches for the first lower case alphabetic character in <cString>. If <lMode> is .T., the function searches for the first non-alphabetic character that would not be changed by UPPER(). The <nIgnore> parameter excludes a specific number of characters at the beginning of the <cString> from the search.

Notes

. Characters located when the <lMode> parameter is designated as .T. are not necessarily upper case, alphabetic characters. . The function works in conjunction with the NATION module because different languages use different characters to represent their alphabets.

Example

       cString  :=  "123ABCuabc"
           ? POSLOWER(cString)                 // Result: 7
           ? POSLOWER(cString, .T.)            // Result: 1
           ? POSLOWER(cString, .F., 7)         // Result: 8

Compliance

POSLOWER() is compatible with CT3’s POSLOWER().

Platforms

All

Files

Source is pos1.c, library is libct.

Seealso

POSALPHA(), POSUPPER(), POSRANGE()

POSINS()

Posted on by vivaclipper

POSINS()

Insert characters at a certain position within a string

Syntax

       POSINS( <cString>, <cInsert>, [<nPosition>] ) 
                -> cString

Arguments

<cString> Designates the character string into which characters are inserted.

<cInsertstring> Designates the new characters that are inserted into <cString>.

<nPosition> Designates the position where the new characters are inserted within <cString>. The default value inserts the characters in front of the last character.

Returns

POSINS() returns the string with the inserted characters.

Description

You can use POSINS() to insert characters into an existing character string. The <cInsertstring> characters are inserted into the <cString> at the location specified by <nPosition>.

Note

. The resulting character string is longer than the original, so this function cannot be called by reference.

Examples

       .  Insert "123" at position 2:
              ? POSINS("abcdefgh", "123", 2)   // "a123bcdefgh"
           .  Insert "123" at position 8:
              ? POSINS("abcdefgh", "123", 8)   // "abcdefg123h"
           .  Give an erroneous position:
              ? POSINS("abcdefgh", "123", 10)  // "abcdefgh"

Compliance

POSINS() is compatible with CT3’s POSINS().

Platforms

All

Files

Source is pos2.c, library is libct.

Seealso

POSCHAR, POSDEL(), POSREPL()

POSEQUAL()

Posted on by vivaclipper

POSEQUAL()

The left-most position there two string begin to be equal

Syntax

       POSEQUAL( <cString1>, <cString2>, [<nCompare>], [<nIgnore>] )
                  -> nPosition

Arguments

<cString1> and <cString2> Designate the two character strings that are compared.

<nCompare> Designates the number of characters that must be the same. The default value is the length of the shorter string.

<nIgnore> Designates the number of characters that are disregarded at the beginning of the search. The default value is none.

Returns

POSEQUAL() returns the position from which the two character strings are the same for <nCompare> characters. If no corresponding agreement is found, the function returns 0.

Description

POSEQUAL() allows you to determine at which point two strings agree. The length of this agreement is represented by <nCompare>. If not specified, <nCompare> defaults to the length of the shorter string.

Additionally, the <nIgnore> parameter lets you specify a particular number of characters that are excluded from the start of the strings during the comparison.

Examples

       .  In this example, there is no agreement to the end of the
              string:
              cString1   :=  "ABCDEFGHI"
              cString2   :=  "XYZDEKLMN"
              ? POSEQUAL(cString1, cString2)                  // Result: 0
           .  This example shows the agreement of at least two characters:
              ? POSEQUAL(cString1, cString2, 2)               // Result: 4
           .  This example shows a single character agreement and excludes
              the first four characters:
              ? POSEQUAL(cString1, cString2, 1, 4)            // Result: 5

Compliance

POSEQUAL() is compatible with CT3’s POSEQUAL().

Platforms

All

Files

Source is posdiff.c, library is libct.

Seealso

POSDIFF()

POSDIFF()

Posted on by vivaclipper

POSDIFF()

The left-most position there two string differ

Syntax

       POSDIFF( <cString1>, <cString2>, [<nIgnore>] ) 
                -> nPosition

Arguments

<cString1> and <cString2> Designate the two character strings that are compared.

<nIgnore> Designates how many characters at the beginning of the character strings are excluded from the search. The default value excludes none (0).

Returns

POSDIFF() returns the first position where <cString1> and <cString2> differ. If both character strings are equal, then the function returns 0.

Description

POSDIFF() compares two strings and determines from which position the first difference occurs. The <nIgnore> parameter allows you to exclude a particular number of characters from the beginning of both character strings from the search.

Note

. Character strings of different lengths can be compared with each other (see examples).

Examples

       .  This example compares two strings of the same length:
              cString1  :=  "X23AB\/A"
              cString2  :=  "X23A8\/A"
              ? POSDIFF(cString1, cString2)           // Result: 5
           .  Two strings of different lengths can also be compared:
              ? POSDIFF("AB", "ABC")                  // Result: 3

Compliance

POSDIFF() is compatible with CT3’s POSDIFF().

Platforms

All

Files

Source is posdiff.c, library is libct.

Seealso

POSEQUAL()

POSDEL()

Posted on by vivaclipper

POSDEL()

Delete characters at a certain position within a string

Syntax

       POSDEL(<cString>,[<nStartPos>],[<nNumber>])
              --> cString

Arguments

<cString> Designates the character string from which the characters are deleted.

<nStartPosition> Designates from which position the deletion begins.

<nNumber> Designates the number of characters to delete.

Returns

The modified string is returned.

Description

This function permits the removal of <nNumber> of characters from <cString>, beginning from <nStartPos>.

Note

. <nStartPos> is optional. If this parameter is not specified, then POSDEL() begins at the end of the <cString> and deletes the specified number (<nNumber>) of characters.

Examples

       .  Delete two characters from a string:
              ? POSDEL("Parameter", 3, 2)         // "Pameter"
           .  Delete the last two characters:
              ? POSDEL("Parameter", , 2)          // "Paramet"

Compliance

POSDEL() is compatible with CT3’s POSDEL().

Platforms

All

Files

Source is pos2.c, library is libct.

Seealso

POSCHAR(), POSINS(), POSREPL()

POSCHAR()

Posted on by vivaclipper

POSCHAR()

Replace character at a certain position within a string

Syntax

       POSCHAR(<cString>,<cCharacter|nCharacter>,
              [<nPosition>]) --> cString

Arguments

<cString> [@] Designates the character string within which the individual character

<cCharacter|nCharacter> is substituted. <cCharacter|nCharacter> Designates an individual character or a numeric ASCII value from 0 to 255.

<nPosition> Designates the position at which the character is substituted. The default value is the last position in <cString>.

Returns

The string returned is the <cString> with a <cCharacter|nCharacter> character in the selected position.

Description

POSCHAR() allows you to replace an individual character within a string without having to split the string. Since this character is only substituted at the designated position within <cString>, the string that is modified can be passed by reference.

Note

. The value returned by this function can be suppressed by implementing CSETREF() to save space in working memory.

Examples

       .  Substitute a character at position 3:
              ? POSCHAR("ABCDEF", "X", 3)   // "ABXDEF"
           .  Substitute a character in the last position:
              ? POSCHAR("ABCDEF", "X")      // "ABCDEX"
           .  Pass the string by reference:
              CSETREF(.T.)                  // Suppress return value
              cVar  := "ABCDEF"
              POSCHAR(cVar, "X")
              ? cVar                        // "ABCDEX"

Compliance

POSCHAR() is compatible with CT3’s POSCHAR().

Platforms

All

Files

Source is pos2.c, library is libct.

Seealso

POSDEL(), POSINS(), POSREPL(), CSETREF()

POSALPHA()

Posted on by vivaclipper

POSALPHA()

Left-most position of a letter in a string

Syntax

       POSALPHA( <cString>, [<lMode>], [<nIgnore>] ) -> nPosition

Arguments

<cString> Designates the string that is searched.

<lMode> Designates how the function searches for the first alphabetic character in a string. The default value (.F.) searches for the first alphabetic character.

<nIgnore> Designates the number of characters at the beginning of the character string that are excluded from the search. The default value excludes none (0).

Returns

The value returned is the position of the first alphabetic character in <cString>. If no alphabetic character is located, the function returns 0.

Description

Starting from the left, POSALPHA() searches for the first alphabetic character in <cString> that corresponds to the first character that can be changed by the Harbour LOWER() or UPPER() functions. If <lMode> is .T., then the function searches for the first non-alphabetic character. The <nIgnore> parameter can exclude a specific number of characters at the beginning of the <cString> from the search.

Notes

. Notice that characters located when <lMode> is .T. are always numbers or special characters, but are never alphabetic characters. . This function works in conjunction with the NATION module because different languages use different characters to represent their alphabets.

Example

       cString  :=  "UKLM123"
           ? POSALPHA(cString)                 // Result: 1
           ? POSALPHA(cString, .T.)            // Result: 5
           ? POSALPHA(cString, .F., 2)         // Result: 3

Compliance

POSALPHA() is compatible with CT3’s POSALPHA().

Platforms

All

Files

Source is pos1.c, library is libct.

Seealso

POSLOWER(), POSUPPER(), POSRANGE()