Vp friend delete: Difference between revisions

From Virtual Paradise Wiki
Jump to navigation Jump to search
Sleepy E (talk | contribs)
Basic layout
 
Sleepy E (talk | contribs)
m User id is passed, not name
Line 1: Line 1:
{{sdk method page|friend_delete|Delete a user from the friend list.
{{sdk method page|friend_delete|Delete a user from the friend list.
|paramex=name
|paramex=friend_user_id
|parameters=
|parameters=
   {{sdk parameter row|int|friend_user_id|User id of user to delete}}
   {{sdk parameter row|int|friend_user_id|User id of user to delete}}

Revision as of 21:38, 30 July 2018

Method call snippet vp_friend_delete(instance, friend_user_id);

Delete a user from the friend list.

Parameters

These are the parameters that this method requires:

Parameter Usage
VPInstance
instance
Pointer to the instance this method call is intended for
int
friend_user_id
User id of user to delete

Returns

This method returns a return code integer, which indicates whether the call was successful or errored for any reason:

Return code Cause
VP_RC_SUCCESS Successful call (for methods that have a registered callback, it only means the request has been sent)

Behavior

There is no special behavior for this method

Examples

This method has no usage examples; please add at least one to this page

See also