Generic Device property control
[Port Access, Device Initialization]

Functions
	APIFUNC (TOKEN, Device_GetRoot,(int port)) APIFUNC(TOKEN
int TOKEN TOKEN prev	APIFUNC (TOKEN, Property_ParseName,(int port, const char *propname)) APIFUNC(const char *
int TOKEN TOKEN prev int TOKEN p	APIFUNC (PropertyType, Property_GetType,(int port, TOKEN p)) APIFUNC(unsigned long
int TOKEN TOKEN prev int TOKEN p int TOKEN p	APIFUNC (int, Device_GetProperty,(int port, TOKEN p, PFValue *value)) APIFUNC(int
int TOKEN TOKEN prev int TOKEN p int TOKEN p int TOKEN char int len	APIFUNC (int, Device_SetProperty,(int port, TOKEN p, PFValue *value)) APIFUNC(int
Variables
	Property_Select
int TOKEN	parent
int TOKEN TOKEN prev	Property_GetName
int TOKEN TOKEN prev int TOKEN p	Property_GetFlags
int TOKEN TOKEN prev int TOKEN p int TOKEN p	Device_GetProperty_String
int TOKEN TOKEN prev int TOKEN p int TOKEN p int TOKEN	p
int TOKEN TOKEN prev int TOKEN p int TOKEN p int TOKEN char *	outs
int TOKEN TOKEN prev int TOKEN p int TOKEN p int TOKEN char int len	Device_SetProperty_String

---

Detailed Description

This contains the function set necessary to control arbitrary device properties.

---

Function Documentation

int TOKEN TOKEN prev int TOKEN p int TOKEN p int TOKEN char int len APIFUNC	(	int	,
		Device_SetProperty	,
		(int port, TOKEN p, PFValue *value)
	)

Set the value of a property.

Parameters:

	port	Port number of the camera
	p	The property token whose value is to be requested
	value	Pointer to a PFValue containing the value to be set.

Returns:

The standard return code Set the value of a property by string.

This function parses a string and tries to match it to the specified property.

Parameters:

	port	Port number of the camera
	p	The property token whose value is to be set
	string	Pointer to a string containing the value to be set.

Returns:

The standard return code

Type Constraints

int TOKEN TOKEN prev int TOKEN p int TOKEN p APIFUNC	(	int	,
		Device_GetProperty	,
		(int port, TOKEN p, PFValue *value)
	)

Get the value of a property.

By default, a property value is owned by the caller, i.e. in case of a dynamic string property, the caller is responsible for allocating the proper memory and initializing the PFValue pointer field. In case of a static string property, the string is owned by the library, so the PFValue does not need to be initialized. See also PFValue documentation.

Parameters:

	port	Port number of the camera
	p	The property token whose value is to be requested
	value	Pointer to a PFValue which contains the property value after successful return of this function. Note that in case of a non static string property, the property value must be initialized first.

Returns:

A standard return code Get the value of a property by string

Parameters:

	port	Port number of the camera
	p	The property token whose value is to be requested
	outs	Pointer to a string which contains the property value string conversion after successful return of this function. The caller must reserve a string of the length of the expected value string.
	len	Length of the string that was reserved by caller

Note:

This function only applies to simple datatypes, resp. only displays debugging information about some complex data types.

Returns:

The standard return code

Type Constraints

int TOKEN TOKEN prev int TOKEN p APIFUNC	(	PropertyType	,
		Property_GetType	,
		(int port, TOKEN p)
	)

Get the property data type by token

Parameters:

	port	Port number of the camera
	p	The property token whose type are to be queried

Returns:

The type of the property Get the property flags by token

Parameters:

	port	Port number of the camera
	p	The property token whose flags are to be queried

Returns:

The property flags

Type Constraints

int TOKEN TOKEN prev APIFUNC	(	TOKEN	,
		Property_ParseName	,
		(int port, const char *propname)
	)			const

Get a property handle (TOKEN) by name.

Parameters:

	port	Port number of the camera *
	propname	Pointer to a string containing the property name

Returns:

The TOKEN of the property. If not existing, INVALID_TOKEN. Get the name of a property by token

Parameters:

	port	Port number of the camera
	p	The token of the property whose name is to be queried

Returns:

Pointer to the constant property string

Type Constraints

APIFUNC	(	TOKEN	,
		Device_GetRoot	,
		(int port)
	)

Get root namespace descriptor token of current device

This function always returns a valid token.

Parameters:

port

Port number of the camera

Returns:

The root descriptor token Select a property in the property and feature hierarchy.

This function is used to query a property inside the property hierarchy which is organized in a tree. A property can have children and has always a parent, except if it is the root node.

Quick overview: To select the first child of a node, use:

     child = pfProperty_Select(port, node, node); 

To select the next children of that node:

     next = pfProperty_Select(port, node, child); 

Parameters:

	port	Port number of the camera
	parent	The parent node to be queried
	prev	The node whose following (next) node shall be selected If the parent node is specified, its first children is selected.

Returns:

The next or children token, if existing, INVALID_TOKEN otherwise.