Difference between revisions of "Osiris/API/GetUserProfileID"

From Divinity Engine Wiki
Jump to: navigation, search
(Document GetUserProfileID)
 
m
 
(One intermediate revision by the same user not shown)
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|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.
+
* '''_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 =====
 
* /
 
* /
Line 12: Line 12:
 
* [[Osiris/API/CharacterGetReservedUserID|CharacterGetReservedUserID]]
 
* [[Osiris/API/CharacterGetReservedUserID|CharacterGetReservedUserID]]
 
   
 
   
[[Category:Osiris Queries]]
+
[[Category:Osiris Queries|GetUserProfileID]]

Latest revision as of 15:33, 19 December 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
  • /
See Also