Difference between revisions of "ISInterface:GetSessionName"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
===Syntax=== | ===Syntax=== | ||
| − | + | *bool GetSessionName(unsigned long nSession, char *buf, int buflen) | |
== Purpose == | == Purpose == | ||
| − | + | To obtain the name of a given session | |
== Usage == | == Usage == | ||
=== Parameters === | === Parameters === | ||
| − | + | *unsigned long nSession | |
| + | :'''[in]''' Number of the session to get the name for | ||
| + | *char *buf | ||
| + | :'''[out]''' Buffer to put the name of the session in | ||
| + | *int buflen | ||
| + | :'''[in]''' Length of the buffer | ||
=== Return Value === | === Return Value === | ||
| − | + | *bool | |
| + | :Returns true on success, false on failure | ||
== Examples == | == Examples == | ||
| − | + | char SessionName[512]; | |
| + | pISInterface->GetSessionName(1,SessionName,sizeof(SessionName)); | ||
== See Also == | == See Also == | ||
Latest revision as of 00:32, 3 September 2005
Syntax
- bool GetSessionName(unsigned long nSession, char *buf, int buflen)
Purpose
To obtain the name of a given session
Usage
Parameters
- unsigned long nSession
- [in] Number of the session to get the name for
- char *buf
- [out] Buffer to put the name of the session in
- int buflen
- [in] Length of the buffer
Return Value
- bool
- Returns true on success, false on failure
Examples
char SessionName[512]; pISInterface->GetSessionName(1,SessionName,sizeof(SessionName));
