Vp create: Difference between revisions

From Virtual Paradise Wiki
Jump to navigation Jump to search
m (Updated to new API)
mNo edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{sdk method page|create|Creates a VPInstance in memory for use with connecting to a world or universe.
{{sdk method page|create|Creates a new SDK instance in memory for connecting to a universe and world.
|parameters=
|parameters=
   {{sdk parameter row|vp_net_config*|net_config|Network configuration for the instance or NULL to use the default select-based implementation. The contents of the structure will be copied.}}
   {{sdk parameter row|vp_net_config*|net_config|Network configuration for the instance or NULL to use the default select-based implementation. The contents of the structure will be copied.}}
Line 6: Line 6:
|returns=A pointer to the newly created instance, or {{code|NULL}} if something went wrong whilst trying to create one.
|returns=A pointer to the newly created instance, or {{code|NULL}} if something went wrong whilst trying to create one.
|examples=
|examples=
<syntaxhighlight lang="c">VPInstance instance;
<syntaxhighlight lang="c">
instance = vp_create(NULL);</syntaxhighlight>
VPInstance instance;
 
instance = vp_create(NULL);
if (!instance)
  printf("Unable to create instance\n");
</syntaxhighlight>
|seealso=
|seealso=
* {{sdk method|connect_universe}}
* {{sdk method|connect_universe}}

Latest revision as of 19:18, 1 August 2018

Method call snippet vp_create(net_config);

Creates a new SDK instance in memory for connecting to a universe and world.

Parameters

These are the parameters that this method requires:

Parameter Usage
vp_net_config*
net_config
Network configuration for the instance or NULL to use the default select-based implementation. The contents of the structure will be copied.

Returns

A pointer to the newly created instance, or NULL if something went wrong whilst trying to create one.

Behavior

There is no special behavior for this method

Examples

VPInstance instance;

instance = vp_create(NULL);
if (!instance)
  printf("Unable to create instance\n");

See also