Difference between revisions of "User withdrawPoints"

From Catglobe Wiki
Jump to: navigation, search
Line 23: Line 23:
  
 
''number p = User_withdrawPoints(120, "Withdraw", 456546)'';
 
''number p = User_withdrawPoints(120, "Withdraw", 456546)'';
 +
 +
//return 0 or the number of withdrawn points
  
 
'''Availability'''
 
'''Availability'''

Revision as of 09:50, 22 December 2011



User_withdrawPoints

Withdraw a number of points from a user

Syntax

User_withdrawPoints(points, description, userResourceId)

Arguments

  • points: is a number expression. It is the number of points to withdraw
  • description: is a string expression. It is the transaction's description
  • userResourceId: is a number expression. It is the user's resource id

Return value

A number, if the process succeeds, return 0, return the number of points otherwise

Example

number p = User_withdrawPoints(120, "Withdraw", 456546);

//return 0 or the number of withdrawn points

Availability

Version 5.6