VMS Help  —  DCE  DCE_INTRO, dce_cf_intro, dce_cf_get_cell_aliases
  NAME
      dce_cf_get_cell_aliases - Returns a list of aliases for the local
                                cell

  SYNOPSIS

      #include <dce/dce_cf.h>

      void dce_cf_get_cell_aliases( char ***cell_alias_list,
                                    error_status_t *status);

  PARAMETERS

      INPUT

      None.

      OUTPUT

      cell_alias_list - The address of a string pointer array. This
                        routine sets this address to point to the
                        address of an allocated null-terminated array
                        of pointers to the cell alias names for the
                        local cell.  If no aliases exist, the routine
                        returns NULL in this parameter.

      status - Returns the status code from this operation. The status
               code is a value that indicates whether the routine
               completed successfully and if not, why not.
               Possible status codes and their meanings are as follows:

               dce_cf_st_ok            Operation completed succesfully.

               dce_cf_e_file_open      File open error.

               dce_cf_e_no_mem         No memory available.

               dce_cf_e_no_match       No match for key in the file.

  DESCRIPTION

  The dce_cf_get_cell_aliases() routine retrieves the local cell's cell
  name aliases. If cell aliases are found, the routine returns the
  address of an allocated list of cell alias names in the cell_alias_list
  parameter.  If no aliases exist for the cell, the routine returns NULL.

  Use the dce_cf_free_cell_aliases() routine to free the memory allocated
  by the dce_cf_get_cell_aliases() routine.

  RETURN VALUES

      No value is returned.

  RELATED INFORMATION

      FUNCTIONS: dce_cf_free_cell_aliases
                 dce_cf_get_cell_name
                 dce_cf_get_host_name
                 dce_cf_same_cell_name

      BOOKS: OSF DCE Application Development Guide-Core Components,
             OSF DCE Command Reference.
Close Help