| libgphoto2 photo camera library (libgphoto2) API
    2.5.16
    | 
#include <gphoto2/gphoto2-port.h>

Go to the source code of this file.
| Typedefs | |
| typedef struct _GPPortInfo * | GPPortInfo | 
| typedef struct _GPPortInfoList | GPPortInfoList | 
| 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, GP_PORT_USB_DISK_DIRECT = 1 << 5, GP_PORT_USB_SCSI = 1 << 6 } | 
| The gphoto port type.  More... | |
| Functions | |
| int | gp_port_info_new (GPPortInfo *info) | 
| Create a new portinfo.  More... | |
| int | gp_port_info_get_name (GPPortInfo info, char **name) | 
| Get name of a specific port entry.  More... | |
| int | gp_port_info_set_name (GPPortInfo info, const char *name) | 
| Set name of a specific port entry.  More... | |
| int | gp_port_info_get_path (GPPortInfo info, char **path) | 
| Get path of a specific port entry.  More... | |
| int | gp_port_info_set_path (GPPortInfo info, const char *path) | 
| Set path of a specific port entry.  More... | |
| int | gp_port_info_get_type (GPPortInfo info, GPPortType *type) | 
| Get type of a specific port entry.  More... | |
| int | gp_port_info_set_type (GPPortInfo info, const GPPortType type) | 
| Set type of a specific port entry.  More... | |
| int | gp_port_info_get_library_filename (GPPortInfo info, char **lib) | 
| int | gp_port_info_set_library_filename (GPPortInfo info, char *lib) | 
| int | gp_port_info_list_new (GPPortInfoList **list) | 
| Create a new GPPortInfoList.  More... | |
| int | gp_port_info_list_free (GPPortInfoList *list) | 
| Free a GPPortInfo list.  More... | |
| int | gp_port_info_list_append (GPPortInfoList *list, GPPortInfo info) | 
| Append a portinfo to the port information list.  More... | |
| int | gp_port_info_list_load (GPPortInfoList *list) | 
| Load system ports.  More... | |
| int | gp_port_info_list_count (GPPortInfoList *list) | 
| Number of ports in the list.  More... | |
| int | gp_port_info_list_lookup_path (GPPortInfoList *list, const char *path) | 
| Lookup a specific path in the list.  More... | |
| int | gp_port_info_list_lookup_name (GPPortInfoList *list, const char *name) | 
| Look up a name in the list.  More... | |
| int | gp_port_info_list_get_info (GPPortInfoList *list, int n, GPPortInfo *info) | 
| Get port information of specific entry.  More... | |
| const char * | gp_port_message_codeset (const char *) | 
| Specify codeset for translations.  More... | |
| 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.
| int gp_port_info_get_name | ( | GPPortInfo | info, | 
| char ** | name | ||
| ) | 
Get name of a specific port entry.
| info | a #GPPortInfo | 
| name | a pointer to a char* which will receive the name | 
Retreives the name of the passed in GPPortInfo, by reference.
References GP_OK, and _GPPortInfo::name.
| int gp_port_info_get_path | ( | GPPortInfo | info, | 
| char ** | path | ||
| ) | 
Get path of a specific port entry.
| info | a #GPPortInfo | 
| path | a pointer to a char* which will receive the path | 
Retreives the path of the passed in GPPortInfo, by reference.
References GP_OK, and _GPPortInfo::path.
| int gp_port_info_get_type | ( | GPPortInfo | info, | 
| GPPortType * | type | ||
| ) | 
Get type of a specific port entry.
| info | a #GPPortInfo | 
| type | a pointer to a GPPortType variable which will receive the type | 
Retreives the type of the passed in GPPortInfo
References GP_OK, and _GPPortInfo::type.
| int gp_port_info_list_append | ( | GPPortInfoList * | list, | 
| GPPortInfo | info | ||
| ) | 
Append a portinfo to the port information list.
| 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.
References _GPPortInfo::name.
| int gp_port_info_list_count | ( | GPPortInfoList * | list | ) | 
Number of ports in the list.
| list | a #GPPortInfoList | 
Returns the number of entries in the passed list.
References _GPPortInfo::name.
Referenced by gp_camera_autodetect().
| int gp_port_info_list_free | ( | GPPortInfoList * | list | ) | 
Free a GPPortInfo list.
| list | a #GPPortInfoList | 
Frees a GPPortInfoList structure and its internal data structures.
References GP_OK, _GPPortInfo::library_filename, _GPPortInfo::name, and _GPPortInfo::path.
Referenced by gp_camera_autodetect().
| int gp_port_info_list_get_info | ( | GPPortInfoList * | list, | 
| int | n, | ||
| GPPortInfo * | info | ||
| ) | 
Get port information of specific entry.
| list | a #GPPortInfoList | 
| n | the index of the entry | 
| info | the returned information | 
Returns a pointer to the current port entry.
References GP_OK, and _GPPortInfo::name.
| int gp_port_info_list_load | ( | GPPortInfoList * | list | ) | 
Load system ports.
| 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.
Referenced by gp_camera_autodetect().
| int gp_port_info_list_lookup_name | ( | GPPortInfoList * | list, | 
| const char * | name | ||
| ) | 
Look up a name in the list.
| list | a #GPPortInfoList | 
| name | a name | 
Looks for an entry in the list with the exact given name.
References GP_ERROR_UNKNOWN_PORT, and _GPPortInfo::name.
| int gp_port_info_list_lookup_path | ( | GPPortInfoList * | list, | 
| const char * | path | ||
| ) | 
Lookup a specific path in the list.
| 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:*".
| int gp_port_info_list_new | ( | GPPortInfoList ** | list | ) | 
Create a new GPPortInfoList.
| 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.
Referenced by gp_camera_autodetect().
| int gp_port_info_new | ( | GPPortInfo * | info | ) | 
Create a new portinfo.
| info | pointer to a #GPPortInfo | 
Allocates and initializes a GPPortInfo structure. This is a libgphoto2_port internal function.
References GP_OK.
| int gp_port_info_set_name | ( | GPPortInfo | info, | 
| const char * | name | ||
| ) | 
Set name of a specific port entry.
| info | a #GPPortInfo | 
| name | a char* pointer which will receive the name | 
Sets the name of the passed in GPPortInfo This is a libgphoto2_port internal function.
References GP_OK, and _GPPortInfo::name.
| int gp_port_info_set_path | ( | GPPortInfo | info, | 
| const char * | path | ||
| ) | 
Set path of a specific port entry.
| info | a #GPPortInfo | 
| path | a char* pointer which will receive the path | 
Sets the path of the passed in GPPortInfo This is a libgphoto2_port internal function.
References GP_OK, and _GPPortInfo::path.
| int gp_port_info_set_type | ( | GPPortInfo | info, | 
| GPPortType | type | ||
| ) | 
Set type of a specific port entry.
| info | a #GPPortInfo | 
| type | a GPPortType variable which will has the type | 
Sets the type of the passed in GPPortInfo This is a libgphoto2_port internal function.
References GP_OK, and _GPPortInfo::type.
| 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.
| codeset | new codeset to use | 
Referenced by gp_message_codeset().