AuroraMiddleware/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Adjust documentation to implementations and alphabetical order.

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@31155 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Włodzimierz Skiba 2004-12-27 20:48:31 +00:00
parent 2b7295c904
commit f866562999
1 changed files with 44 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

87
docs/latex/wx/function.tex
View File

@ -1242,13 +1242,29 @@ The functions in this section are used to retrieve information about the
current computer and/or user characteristics.
\membersection{::wxGetEmailAddress}\label{wxgetemailaddress}
\func{wxString}{wxGetEmailAddress}{\void}
\func{bool}{wxGetEmailAddress}{\param{char * }{buf}, \param{int }{sz}}
Copies the user's email address into the supplied buffer, by
concatenating the values returned by \helpref{wxGetFullHostName}{wxgetfullhostname}\rtfsp
and \helpref{wxGetUserId}{wxgetuserid}.
Returns true if successful, false otherwise.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxGetFreeMemory}\label{wxgetfreememory}
\func{wxMemorySize}{wxGetFreeMemory}{\void}
Returns the amount of free memory in bytes under environments which
support it, and -1 if not supported. Currently, it is supported only
under Windows, Linux and Solaris.
support it, and -1 if not supported or failed to perform measurement.
\wxheading{Include files}
@ -1271,21 +1287,6 @@ error.
<wx/utils.h>
\membersection{::wxGetEmailAddress}\label{wxgetemailaddress}
\func{bool}{wxGetEmailAddress}{\param{const wxString\& }{buf}, \param{int }{sz}}
Copies the user's email address into the supplied buffer, by
concatenating the values returned by \helpref{wxGetFullHostName}{wxgetfullhostname}\rtfsp
and \helpref{wxGetUserId}{wxgetuserid}.
Returns true if successful, false otherwise.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxGetHomeDir}\label{wxgethomedir}
\func{wxString}{wxGetHomeDir}{\void}
@ -1328,32 +1329,6 @@ if successful, false otherwise.
<wx/utils.h>
\membersection{::wxGetUserId}\label{wxgetuserid}
\func{wxString}{wxGetUserId}{\void}
\func{bool}{wxGetUserId}{\param{char * }{buf}, \param{int }{sz}}
This function returns the "user id" also known as "login name" under Unix i.e.
something like "jsmith". It uniquely identifies the current user (on this system).
Under Windows or NT, this function first looks in the environment
variables USER and LOGNAME; if neither of these is found, the entry {\bf UserId}\rtfsp
in the {\bf wxWidgets} section of the WIN.INI file is tried.
The first variant of this function returns the login name if successful or an
empty string otherwise. The second (deprecated) function returns true
if successful, false otherwise.
\wxheading{See also}
\helpref{wxGetUserName}{wxgetusername}
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxGetOsDescription}\label{wxgetosdescription}
\func{wxString}{wxGetOsDescription}{\void}
@ -1415,6 +1390,32 @@ Returns the home directory for the given user. If the username is empty
<wx/utils.h>
\membersection{::wxGetUserId}\label{wxgetuserid}
\func{wxString}{wxGetUserId}{\void}
\func{bool}{wxGetUserId}{\param{char * }{buf}, \param{int }{sz}}
This function returns the "user id" also known as "login name" under Unix i.e.
something like "jsmith". It uniquely identifies the current user (on this system).
Under Windows or NT, this function first looks in the environment
variables USER and LOGNAME; if neither of these is found, the entry {\bf UserId}\rtfsp
in the {\bf wxWidgets} section of the WIN.INI file is tried.
The first variant of this function returns the login name if successful or an
empty string otherwise. The second (deprecated) function returns true
if successful, false otherwise.
\wxheading{See also}
\helpref{wxGetUserName}{wxgetusername}
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxGetUserName}\label{wxgetusername}
\func{wxString}{wxGetUserName}{\void}