Changeset View
Changeset View
Standalone View
Standalone View
doc/gpgme.texi
Context not available. | |||||
largefile support add-on. Then a new data type @code{off64_t} is | largefile support add-on. Then a new data type @code{off64_t} is | ||||
provided, which is 64 bit wide. Or you can replace the existing | provided, which is 64 bit wide. Or you can replace the existing | ||||
@code{off_t} data type with its 64 bit wide counterpart. All | @code{off_t} data type with its 64 bit wide counterpart. All | ||||
occurences of @code{off_t} are then automagically replaced. | occurrences of @code{off_t} are then automagically replaced. | ||||
As if matters were not complex enough, there are also two different | As if matters were not complex enough, there are also two different | ||||
types of file descriptors in such systems. This is important because | types of file descriptors in such systems. This is important because | ||||
if file descriptors are exchanged between programs that use a | if file descriptors are exchanged between programs that use a | ||||
different maximum file size, certain errors must be produced on some | different maximum file size, certain errors must be produced on some | ||||
file descriptors to prevent subtle overflow bugs from occuring. | file descriptors to prevent subtle overflow bugs from occurring. | ||||
As you can see, supporting two different maximum file sizes at the | As you can see, supporting two different maximum file sizes at the | ||||
same time is not at all an easy task. However, the maximum file size | same time is not at all an easy task. However, the maximum file size | ||||
Context not available. | |||||
@item require-gnupg | @item require-gnupg | ||||
Set the mimimum version of the required GnuPG engine. If that version | Set the mimimum version of the required GnuPG engine. If that version | ||||
is not met, GPGME fails early instead of trying to use the existant | is not met, GPGME fails early instead of trying to use the existent | ||||
version. The given version must be a string with major, minor, and | version. The given version must be a string with major, minor, and | ||||
micro number. Example: "2.1.0". | micro number. Example: "2.1.0". | ||||
Context not available. | |||||
The new defaults are not applied to already created GPGME contexts. | The new defaults are not applied to already created GPGME contexts. | ||||
This function returns the error code @code{GPG_ERR_NO_ERROR} if | This function returns the error code @code{GPG_ERR_NO_ERROR} if | ||||
successful, or an eror code on failure. | successful, or an error code on failure. | ||||
@end deftypefun | @end deftypefun | ||||
The functions @code{gpgme_ctx_get_engine_info} and | The functions @code{gpgme_ctx_get_engine_info} and | ||||
Context not available. | |||||
@code{0}. Also, it is guaranteed that an error value made from the | @code{0}. Also, it is guaranteed that an error value made from the | ||||
error code @code{0} will be @code{0} itself (as a whole). This means | error code @code{0} will be @code{0} itself (as a whole). This means | ||||
that the error source information is lost for this error code, | that the error source information is lost for this error code, | ||||
however, as this error code indicates that no error occured, this is | however, as this error code indicates that no error occurred, this is | ||||
generally not a problem. | generally not a problem. | ||||
@item GPG_ERR_GENERAL | @item GPG_ERR_GENERAL | ||||
Context not available. | |||||
the certificate. | the certificate. | ||||
@item GPG_ERR_NO_POLICY_MATCH | @item GPG_ERR_NO_POLICY_MATCH | ||||
This value indicates that a policy issue occured. | This value indicates that a policy issue occurred. | ||||
@item GPG_ERR_NO_SECKEY | @item GPG_ERR_NO_SECKEY | ||||
This value indicates that no secret key for the user ID is available. | This value indicates that no secret key for the user ID is available. | ||||
Context not available. | |||||
context @var{ctx}. | context @var{ctx}. | ||||
This function returns the error code @code{GPG_ERR_NO_ERROR} if | This function returns the error code @code{GPG_ERR_NO_ERROR} if | ||||
successful, or an eror code on failure. | successful, or an error code on failure. | ||||
@end deftypefun | @end deftypefun | ||||
Context not available. | |||||
@item GPGME_KEYLIST_MODE_EXTERN | @item GPGME_KEYLIST_MODE_EXTERN | ||||
The @code{GPGME_KEYLIST_MODE_EXTERN} symbol specifies that an external | The @code{GPGME_KEYLIST_MODE_EXTERN} symbol specifies that an external | ||||
source should be searched for keys in the keylisting operation. The | source should be searched for keys in the keylisting operation. The | ||||
type of external source is dependant on the crypto engine used and | type of external source is dependent on the crypto engine used and | ||||
whether it is combined with @code{GPGME_KEYLIST_MODE_LOCAL}. For | whether it is combined with @code{GPGME_KEYLIST_MODE_LOCAL}. For | ||||
example, it can be a remote keyserver or LDAP certificate server. | example, it can be a remote keyserver or LDAP certificate server. | ||||
Context not available. | |||||
A policy requirement was not met. | A policy requirement was not met. | ||||
@item GPGME_SIGSUM_SYS_ERROR | @item GPGME_SIGSUM_SYS_ERROR | ||||
A system error occured. | A system error occurred. | ||||
@end table | @end table | ||||
@item char *fpr | @item char *fpr | ||||
Context not available. | |||||
If this flag is set the available information is not fresh enough. | If this flag is set the available information is not fresh enough. | ||||
@item error | @item error | ||||
If this flag is set some other error has occured. | If this flag is set some other error has occurred. | ||||
@item version | @item version | ||||
The version string of the latest released version. | The version string of the latest released version. | ||||
Context not available. | |||||
The function @code{gpgme_op_query_swdb_result} returns a | The function @code{gpgme_op_query_swdb_result} returns a | ||||
@code{gpgme_query_swdb_result_t} pointer to a structure holding the | @code{gpgme_query_swdb_result_t} pointer to a structure holding the | ||||
result of a @code{gpgme_op_query_swdb} operation. The pointer is only | result of a @code{gpgme_op_query_swdb} operation. The pointer is only | ||||
valid if the last operation on the context was a sucessful call to | valid if the last operation on the context was a successful call to | ||||
@code{gpgme_op_query_swdb}. If that call failed, the result might | @code{gpgme_op_query_swdb}. If that call failed, the result might | ||||
be a @code{NULL} pointer. The returned pointer is only valid until | be a @code{NULL} pointer. The returned pointer is only valid until | ||||
the next operation is started on the context @var{ctx}. | the next operation is started on the context @var{ctx}. | ||||
Context not available. | |||||
@code{gpgme_event_io_cb_t} function with @acronym{GPGME} and will always be | @code{gpgme_event_io_cb_t} function with @acronym{GPGME} and will always be | ||||
passed as the first argument when registering a callback function. | passed as the first argument when registering a callback function. | ||||
For example, the user can use this to determine the context in which | For example, the user can use this to determine the context in which | ||||
this event has occured. | this event has occurred. | ||||
@var{type} will specify the type of event that has occured. | @var{type} will specify the type of event that has occurred. | ||||
@var{type_data} specifies the event further, as described in the above | @var{type_data} specifies the event further, as described in the above | ||||
list of possible @code{gpgme_event_io_t} types. | list of possible @code{gpgme_event_io_t} types. | ||||
Context not available. | |||||
@item void *event_priv | @item void *event_priv | ||||
This is passed as the first argument to the @code{event} function when | This is passed as the first argument to the @code{event} function when | ||||
it is called by @acronym{GPGME}. For example, it can be used to | it is called by @acronym{GPGME}. For example, it can be used to | ||||
determine the context in which the event has occured. | determine the context in which the event has occurred. | ||||
@end table | @end table | ||||
@end deftp | @end deftp | ||||
Context not available. |