wcswidth(3)                                                 wcswidth(3)

  wcswidth()

  NAME

    wcswidth() - number of column positions of a wide-character string

  SYNOPSIS

    #include 

    int wcswidth(const wchar_t *pwcs, size_t n);

  DESCRIPTION

    The wcswidth(3) function determines the number of column positions
    required for n wide-character codes (or fewer than n wide-character codes
    if a null wide-character code is encountered before n wide-character codes
    are exhausted) in the string pointed to by pwcs.

    The arguments are:

    pwcs
        A pointer to a wide-character string.

    n
        A value indicating the number of wide-characters for the width
        determination.

  RETURN VALUES

    The wcswidth(3) function either returns 0 (if pwcs points to a null wide-
    character code), or returns the number of column positions to be occupied
    by the wide-character string pointed to by pwcs, or returns -1 (if any of
    the first n wide-character codes in the wide-character string pointed to
    by pwcs is not a printing wide-character code).

  ERRORS

    No errors are defined.

  SEE ALSO

    wcwidth(3)

  USAGE NOTES

    The wcswidth function is thread safe.

    The wcswidth function is not async-signal safe.