libgphoto2 photo camera library (libgphoto2) API 2.5.30
gphoto2-port-info-list.h File Reference

Go to the source code of this file.

Typedefs

typedef struct _GPPortInfoGPPortInfo
 
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 , GP_PORT_IP = 1 << 7
}
 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...
 
int gp_port_init_localedir (const char *localedir)
 Initialize the localedir directory for the libgphoto2_port gettext domain. More...
 

Detailed Description

Author
Copyright 2001 Lutz Mueller lutz@.nosp@m.user.nosp@m.s.sf..nosp@m.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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Enumeration Type Documentation

◆ GPPortType

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.

GP_PORT_USB_DISK_DIRECT 

Direct IO to an usb mass storage device.

GP_PORT_USB_SCSI 

USB Mass Storage raw SCSI port.

GP_PORT_IP 

generic IP address port.

Function Documentation

◆ gp_port_info_get_name()

int gp_port_info_get_name ( GPPortInfo  info,
char **  name 
)

Get name of a specific port entry.

Parameters
infoa #GPPortInfo
namea pointer to a char* which will receive the name

Retreives the name of the passed in GPPortInfo, by reference.

Returns
a gphoto2 error code

References GP_OK, and _GPPortInfo::name.

◆ gp_port_info_get_path()

int gp_port_info_get_path ( GPPortInfo  info,
char **  path 
)

Get path of a specific port entry.

Parameters
infoa #GPPortInfo
patha pointer to a char* which will receive the path

Retreives the path of the passed in GPPortInfo, by reference.

Returns
a gphoto2 error code

References GP_OK, and _GPPortInfo::path.

◆ gp_port_info_get_type()

int gp_port_info_get_type ( GPPortInfo  info,
GPPortType type 
)

Get type of a specific port entry.

Parameters
infoa #GPPortInfo
typea pointer to a GPPortType variable which will receive the type

Retreives the type of the passed in GPPortInfo

Returns
a gphoto2 error code

References GP_OK, and _GPPortInfo::type.

◆ gp_port_info_list_append()

int gp_port_info_list_append ( GPPortInfoList list,
GPPortInfo  info 
)

Append a portinfo to the port information list.

Parameters
lista #GPPortInfoList
infothe 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 successful - will append this entry to the list.

Returns
A gphoto2 error code, or an index into the port list (excluding generic entries). which can be used for gp_port_info_list_get_info.

References _GPPortInfo::name.

◆ gp_port_info_list_count()

int gp_port_info_list_count ( GPPortInfoList list)

Number of ports in the list.

Parameters
lista #GPPortInfoList

Returns the number of entries in the passed list.

Returns
The number of entries or a gphoto2 error code

References _GPPortInfo::name.

Referenced by gp_camera_autodetect().

◆ gp_port_info_list_free()

int gp_port_info_list_free ( GPPortInfoList list)

Free a GPPortInfo list.

Parameters
lista #GPPortInfoList

Frees a GPPortInfoList structure and its internal data structures.

Returns
a gphoto2 error code

References GP_OK, _GPPortInfo::library_filename, _GPPortInfo::name, and _GPPortInfo::path.

Referenced by gp_camera_autodetect().

◆ gp_port_info_list_get_info()

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

Get port information of specific entry.

Parameters
lista #GPPortInfoList
nthe index of the entry
infothe returned information

Returns a pointer to the current port entry.

Returns
a gphoto2 error code

References GP_OK, and _GPPortInfo::name.

◆ gp_port_info_list_load()

int gp_port_info_list_load ( GPPortInfoList list)

Load system ports.

Parameters
lista #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

Referenced by gp_camera_autodetect().

◆ gp_port_info_list_lookup_name()

int gp_port_info_list_lookup_name ( GPPortInfoList list,
const char *  name 
)

Look up a name in the list.

Parameters
lista #GPPortInfoList
namea name

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

Returns
The index of the entry or a gphoto2 error code

References GP_ERROR_UNKNOWN_PORT, and _GPPortInfo::name.

◆ gp_port_info_list_lookup_path()

int gp_port_info_list_lookup_path ( GPPortInfoList list,
const char *  path 
)

Lookup a specific path in the list.

Parameters
lista #GPPortInfoList
patha 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

◆ gp_port_info_list_new()

int gp_port_info_list_new ( GPPortInfoList **  list)

Create a new GPPortInfoList.

Parameters
listpointer 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

References GP_OK, and gp_port_init_localedir().

Referenced by gp_camera_autodetect().

◆ gp_port_info_new()

int gp_port_info_new ( GPPortInfo info)

Create a new portinfo.

Parameters
infopointer to a #GPPortInfo

Allocates and initializes a GPPortInfo structure. This is a libgphoto2_port internal function.

Returns
a gphoto2 error code

References GP_OK.

◆ gp_port_info_set_name()

int gp_port_info_set_name ( GPPortInfo  info,
const char *  name 
)

Set name of a specific port entry.

Parameters
infoa #GPPortInfo
namea char* pointer which will receive the name

Sets the name of the passed in GPPortInfo This is a libgphoto2_port internal function.

Returns
a gphoto2 error code

References GP_OK, and _GPPortInfo::name.

◆ gp_port_info_set_path()

int gp_port_info_set_path ( GPPortInfo  info,
const char *  path 
)

Set path of a specific port entry.

Parameters
infoa #GPPortInfo
patha char* pointer which will receive the path

Sets the path of the passed in GPPortInfo This is a libgphoto2_port internal function.

Returns
a gphoto2 error code

References GP_OK, and _GPPortInfo::path.

◆ gp_port_info_set_type()

int gp_port_info_set_type ( GPPortInfo  info,
GPPortType  type 
)

Set type of a specific port entry.

Parameters
infoa #GPPortInfo
typea GPPortType variable which will has the type

Sets the type of the passed in GPPortInfo This is a libgphoto2_port internal function.

Returns
a gphoto2 error code

References GP_OK, and _GPPortInfo::type.

◆ gp_port_init_localedir()

int gp_port_init_localedir ( const char *  localedir)

Initialize the localedir directory for the libgphoto2_port gettext domain.

Override the localedir directory libgphoto2_port uses for its message translations.

This function is called by the gp_init_localedir() function, so if you are calling that already, there is no need to call gp_port_init_localedir() yourself.

You only need to call this if you have a non-standard installation where the locale files are at a location which differs from the compiled in default location.

If you need to call this function, call it before calling any non-initialization function.

Internally, this will make sure bindtextdomain() is called for the relevant gettext text domain(s).

Parameters
localedirRoot directory of libgphoto2_port's localization files. If NULL, use the compiled in default value, which will be something like "/usr/share/locale".
Returns
gphoto2 error code.

References gp_log(), GP_LOG_DEBUG, and GP_OK.

Referenced by gp_init_localedir(), and gp_port_info_list_new().

◆ gp_port_message_codeset()

const char * gp_port_message_codeset ( const char *  codeset)

Specify codeset for translations.

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

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

Parameters
codesetnew codeset to use
Returns
the previous codeset

Referenced by gp_message_codeset().