X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3694bb76c11d1ed1518f20a42f8907c948e190bd..35a7f94b940c450206190b7ca2fe4135f006c46c:/docs/latex/wx/function.tex diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex index 62e622480a..5ab7cee273 100644 --- a/docs/latex/wx/function.tex +++ b/docs/latex/wx/function.tex @@ -1571,11 +1571,14 @@ that there isn't always a standard way to do a reliable check on the OS architec \membersection{::wxGetUserHome}\label{wxgetuserhome} -\func{const wxChar *}{wxGetUserHome}{\param{const wxString\& }{user = ""}} +\func{wxString}{wxGetUserHome}{\param{const wxString\& }{user = ""}} -Returns the home directory for the given user. If the username is empty -(default value), this function behaves like -\helpref{wxGetHomeDir}{wxgethomedir}. +Returns the home directory for the given user. If the \arg{user} is empty +(default value), this function behaves like +\helpref{wxGetHomeDir}{wxgethomedir} i.e. returns the current user home +directory. + +If the home directory couldn't be determined, an empty string is returned. \wxheading{Include files}