vp_url_send
Method call snippet
vp_url_send(instance, session, url, target);
Sends a URL to a client for them to open in a web browser.
Parameters
These are the parameters that this method requires:
Parameter | Usage |
---|---|
VPInstance instance |
Pointer to the instance this method call is intended for |
int session |
Target session ID |
string url |
URL to open |
int target |
Target container to open the URL in |
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) |
VP_RC_NOT_INITIALIZED |
SDK not initialized with vp_init() yet
|
Behavior
- See
VP_URL_TARGET
for valid targets to use
Examples
- This method has no usage examples; please add at least one to this page