@database validPortName.guide

@$VER: validPortName V1.00 - (C)Copyright Amiga Foundation Classes

This guide file has been created using AutoGuide V1.05 - By Fabio Rotondo (fsoft@intercom.it).

@node Main "Amiga Foundation Classes: validPortName"



                   ** validPortName  - Original By Fabio Rotondo **

                       * Part of the Amiga Foundation Classes *

        @{" Introduction " link "validPort_introduction"}  @{" Author's Info " link "author"}  @{" Amiga Foundation Classes " LINK "AFC.Guide/main"}  @{" History " LINK "validPort_History"}



           NAME: validPortName(basename:PTR TO CHAR, count=1)

       SYNOPSIS: STRPTR validPortName(STRPTR basename, CHAR count=1)

    DESCRIPTION: This function helps you TO find an unique Message Port name.
                 The messahe port will be created in the standard format:

                      basename.number

                 For example:

                    'DOPUS.1', 'IMAGEFX.2' ...

                    Where 'basename' is 'DOPUS' and 'IMAGEFX' and number is 1 and 2.


          INPUT: basename     - It must be a *valid* string pointer
                                that _MUST_ be large enough to handle the
                                resulting Message Port name.

                 count        - (Optional) Starting number value.
                                Default is 1.



        RESULTS: portname     - A valid (unique) port name.

           NOTE: The portname will be copied in basename, so be sure that the
                 the string you pass as parameter is large enough to handle
                 the portname correctly.

       SEE ALSO:

@endnode

@node "validPort_Introduction" "Introduction"


  INTRODUCTION

  validPortName is a function that will help you TO find an unique
  Message Port name.

  It is extremely easy TO use AND, even IF it isn't really a class,
  it will be included inside the standard AFC distribution because it
  is used by various classes.

@endnode

@node "author" "Author's Info"

    Original By:    Fabio Rotondo  (fsoft@intercom.it)

    E Version By:   Fabio Rotondo

    Address:

            Fabio Rotondo
            C.so Vercelli 9
            28100 Novara
            ITALY

            e-mail: fsoft@intercom.it
                    Fabio.Rotondo@deagostini.it

            Phone:  (ITA) - (0)321 -   459676  (home)
                    (ITA) - (0)2   - 38086520  (office)
                    (ITA) - (0)338 -  7336477  (GSM Phone)

            Fax:    (ITA) - (0)2   - 38086278

            Web:    http://www.intercom.it/~fsoft               (my home page)

                    http://www.intercom.it/~fsoft/ablast.html   (Amiga Blast Home Page)

@endnode

@node validport_history "Amiga Foundation Classes: validPortName / HISTORY"

  HISTORY

  V1.00 - Initial Release
@endnode

