pm_get_home_txt()

PM_$GET_HOME_TXT                  Domain/OS                   PM_$GET_HOME_TXT


NAME
     pm_$get_home_txt - get the home directory

SYNOPSIS (C)
     #include <apollo/base.h>
     #include <apollo/pm.h>

     void pm_$get_home_txt(
          short &buffer_length,
          char *path_name,
          short *path_length)

SYNOPSIS (Pascal)
     %include '/sys/ins/base.ins.pas';
     %include '/sys/ins/pm.ins.pas';

     procedure pm_$get_home_txt(
          in buffer_length: integer;
          out path_name: univ name_$long_pname_t;
          out path_length: integer);

SYNOPSIS (FORTRAN)
     %include '/sys/ins/base.ins.ftn'
     %include '/sys/ins/pm.ins.ftn'

           integer*2 buffer_length, path_length
           character path_name*1023

           call pm_$get_home_txt(buffer_length, path_name, path_length)

DESCRIPTION
     Pm_$get_home_txt supplies the home directory associated with the SID of
     the calling process in path_name.

     buffer_length
          The number of bytes in the buffer allocated to receive the home
          directory.  Pm_$get_home_txt will not write more than buffer_length
          characters into path_name.

     path_name
          The pathname of the home directory for the calling process.  The
          home directory supplied in path_name is the one associated with the
          SID of the calling process and is the same as the HOME variable in
          the caller's environment.

     path_length
          The number of bytes in the pathname of the home directory.  If the
          value supplied in path_length equals or exceeds the value passed in
          buffer_length then the pathname written in path_name might be trun-
          cated.

SEE ALSO
     name_$get_ndir_lc, name_$get_wdir_lc.
Museum
