gphoto2-port-info-list.h File Reference

#include <gphoto2/gphoto2-port.h>

Include dependency graph for gphoto2-port-info-list.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	_GPPortInfo
	Information about the current port. More...
Typedefs
typedef _GPPortInfo	GPPortInfo
	Information about the current port.
typedef _GPPortInfoList	GPPortInfoList
typedef GPPortInfo	gp_port_info
Enumerations
enum	GPPortType {   GP_PORT_NONE = 0, GP_PORT_SERIAL = 1 << 0, GP_PORT_USB = 1 << 2, GP_PORT_DISK = 1 << 3,   GP_PORT_PTPIP = 1 << 4 }
	The gphoto port type. More...
Functions
int	gp_port_info_list_new (GPPortInfoList **list)
	Create a new GPPortInfoList.
int	gp_port_info_list_free (GPPortInfoList *list)
	Free a GPPortInfo list.
int	gp_port_info_list_append (GPPortInfoList *list, GPPortInfo info)
	Append a portinfo to the port information list.
int	gp_port_info_list_load (GPPortInfoList *list)
	Load system ports.
int	gp_port_info_list_count (GPPortInfoList *list)
	Number of ports in the list.
int	gp_port_info_list_lookup_path (GPPortInfoList *list, const char *path)
	Lookup a specific path in the list.
int	gp_port_info_list_lookup_name (GPPortInfoList *list, const char *name)
	Look up a name in the list.
int	gp_port_info_list_get_info (GPPortInfoList *list, int n, GPPortInfo *info)
	Get port information of specific entry.
const char *	gp_port_message_codeset (const char *)
	Specify codeset for translations.

---

Detailed Description

Author:

Copyright 2001 Lutz Mueller <lutz@users.sf.net>

License

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

---

Typedef Documentation

typedef struct _GPPortInfo GPPortInfo

Information about the current port.

Specific information about the current port. Usually taken from the "--port=XXXX" setting from the frontend.

This is not to be confused with the driver configurable port settings in GPPortSettings.

---

Enumeration Type Documentation

enum GPPortType

The gphoto port type.

Enumeration specifying the port type. The enum is providing bitmasks, but most code uses it as just the one specific values.

Enumerator:

GP_PORT_NONE	No specific type associated.
GP_PORT_SERIAL	Serial port.
GP_PORT_USB	USB port.
GP_PORT_DISK	Disk / local mountpoint port.
GP_PORT_PTPIP	PTP/IP port.

---

Function Documentation

int gp_port_info_list_append	(	GPPortInfoList *	list,
		GPPortInfo	info
	)

Append a portinfo to the port information list.

Parameters:

	list	a GPPortInfoList
	info	the info to append

Appends an entry to the list. This function is typically called by an io-driver during gp_port_library_list. If you leave info.name blank, gp_port_info_list_lookup_path will try to match non-existent paths against info.path and - if successfull - will append this entry to the list.

Note:

This returns index - number of generic entries, not the correct index.

Returns:

A non-negative number or a gphoto2 error code

int gp_port_info_list_count

(

GPPortInfoList *

list

)

Number of ports in the list.

Parameters:

list

a GPPortInfoList

Returns the number of entries in the passed list.

Returns:

The number of entries or a gphoto2 error code

int gp_port_info_list_free

(

GPPortInfoList *

list

)

Free a GPPortInfo list.

Parameters:

list

a GPPortInfoList

Frees a GPPortInfoList structure and its internal data structures.

Returns:

a gphoto2 error code

int gp_port_info_list_get_info	(	GPPortInfoList *	list,
		int	n,
		GPPortInfo *	info
	)

Get port information of specific entry.

Parameters:

	list	a GPPortInfoList
	n	the index of the entry
	info	the returned information

Retreives an entry from the list and stores it into info.

Returns:

a gphoto2 error code

int gp_port_info_list_load

(

GPPortInfoList *

list

)

Load system ports.

Parameters:

list

a GPPortInfoList

Searches the system for io-drivers and appends them to the list. You would normally call this function once after gp_port_info_list_new and then use this list in order to supply gp_port_set_info with parameters or to do autodetection.

Returns:

a gphoto2 error code

int gp_port_info_list_lookup_name	(	GPPortInfoList *	list,
		const char *	name
	)

Look up a name in the list.

Parameters:

	list	a GPPortInfoList
	name	a name

Looks for an entry in the list with the exact given name.

Returns:

The index of the entry or a gphoto2 error code

int gp_port_info_list_lookup_path	(	GPPortInfoList *	list,
		const char *	path
	)

Lookup a specific path in the list.

Parameters:

	list	a GPPortInfoList
	path	a path

Looks for an entry in the list with the supplied path. If no exact match can be found, a regex search will be performed in the hope some driver claimed ports like "serial:*".

Returns:

The index of the entry or a gphoto2 error code

int gp_port_info_list_new

(

GPPortInfoList **

list

)

Create a new GPPortInfoList.

Parameters:

list

pointer to a GPPortInfoList* which is allocated

Creates a new list which can later be filled with port infos (GPPortInfo) using gp_port_info_list_load.

Returns:

a gphoto2 error code

const char* gp_port_message_codeset

(

const char *

codeset

)

Specify codeset for translations.

This function specifies the codeset that are used for the translated strings that are passed back by the libgphoto2_port functions.

This function is called by the gp_message_codeset() function, there is no need to call it yourself.

Parameters:

codeset

new codeset to use

Returns:

the previous codeset

---