Osiris/API/GetUserProfileID: Difference between revisions
Jump to navigation
Jump to search
(Document GetUserProfileID) |
mNo edit summary |
||
| Line 5: | Line 5: | ||
===== Return Values ===== | ===== Return Values ===== | ||
* '''Success/Failure''': Fails if the server component of the game has not started yet, or if no player with '''_UserID''' is connected. | * '''Success/Failure''': Fails if the server component of the game has not started yet, or if no player with '''_UserID''' is connected. | ||
* '''_UserProfileID''': A [https://en.wikipedia.org/wiki/Universally_unique_identifier | * '''_UserProfileID''': A [https://en.wikipedia.org/wiki/Universally_unique_identifier UUID] in string format that identifies the profile used by this user. This UUID is persistent across game sessions. The UUID for a profile is randomly generated when the profile is first created. | ||
===== Notes ===== | ===== Notes ===== | ||
* / | * / | ||
Revision as of 19:11, 28 November 2017
Full Definition(s)
- query GetUserProfileID([in](INTEGER)_UserID,[out](STRING)_UserProfileID)
Description
Returns a persistent UUID string that identifies the user with id _UserID.
Return Values
- Success/Failure: Fails if the server component of the game has not started yet, or if no player with _UserID is connected.
- _UserProfileID: A UUID in string format that identifies the profile used by this user. This UUID is persistent across game sessions. The UUID for a profile is randomly generated when the profile is first created.
Notes
- /