Vp int get: Difference between revisions

Latest revision as of 20:12, 12 December 2016

Method call snippet vp_int_get(instance, attr, value);

Return the value of an integer attribute.

These are the parameters that this method requires:

Parameter	Usage
VPInstance instance	Pointer to the instance this method call is intended for
vp_int_attribute_t attr	Attribute to return value of (defined in VP.h)
int* value	Returns the value

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)
`VP_RC_NO_SUCH_ATTRIBUTE`	Invalid attribute

If unsuccessful, then value is not modified.

int my_owner(VPInstance sdk)
{
  int rc, owner;

  rc = vp_int_get(sdk, VP_MY_USER_ID, &owner);
  if (rc)
    return -1;

  return owner;
}

@@ Line 1: / Line 1: @@
-{{sdk method page|int|Retrieve an integer attribute.
+{{sdk method page|int_get|Return the value of an integer attribute.
 |paramex=attr, value
 |parameters=
-   {{sdk parameter row|vp_int_attribute_t|attr  |Attribute to return}}
+   {{sdk parameter row|vp_int_attribute_t |attr  |Attribute to return value of (defined in VP.h)}}
-   {{sdk parameter row|int*              |value |Returns the value}}
+   {{sdk parameter row|int*               |value |Returns the value}}
 |returncodes=
    {{sdk return code row|NO_SUCH_ATTRIBUTE  |Invalid attribute}}
-|behavior=If an invalid value is passed for attr, then value is not modified.
+|behavior=If unsuccessful, then value is not modified.
 |caveats=
 |examples=
+<syntaxhighlight lang="c">
+int my_owner(VPInstance sdk)
+{
+  int rc, owner;
+  rc = vp_int_get(sdk, VP_MY_USER_ID, &owner);
+  if (rc)
+    return -1;
+  return owner;
+}
+</syntaxhighlight>
 |seealso=
 * {{sdk method|int}}
 * {{sdk method|int_set}}
 }}