User handling


Functions

const char * sp_user_canonical_name (sp_user *user)
const char * sp_user_display_name (sp_user *user)
bool sp_user_is_loaded (sp_user *user)

Function Documentation

const char* sp_user_canonical_name ( sp_user user  ) 

Get a pointer to a string representing the user's canonical username.

Parameters:
[in] user The Spotify user whose canonical username you would like a string representation of
Returns:
A string representing the canonical username.
Examples:
session.c.

const char* sp_user_display_name ( sp_user user  ) 

Get a pointer to a string representing the user's displayable username. If there is no difference between the canonical username and the display name, or if the library does not know about the display name yet, the canonical username will be returned.

Parameters:
[in] user The Spotify user whose displayable username you would like a string representation of
Returns:
A string
Examples:
session.c.

bool sp_user_is_loaded ( sp_user user  ) 

Get load status for a user object. Before it is loaded, only the user's canonical username is known.

Parameters:
[in] user Spotify user object
Returns:
True if user object is loaded, otherwise false
Examples:
session.c.


Generated on Tue Apr 7 15:21:55 2009.
Copyright © 2006–2009 Spotify Ltd