Copyright © 2001 - 2007 SILC Project SILC Project Website | SILC Toolkit Reference Manual Index

SILC Toolkit Reference Manual
SILC VCard Library
SILC VCard Interface
SILC Crypto Library
Introduction to SILC RNG
SILC RNG Interface
SILC Cipher API
SILC PKCS API
SILC Public Key API
SILC PKCS #1 API
SILC Hash Interface
SILC HMAC Interface
SILC Client Library
Using SILC Client Library Tutorial
Arguments for command_reply Client Operation
SilcStatus Error Arguments in command_reply Client Operation
Arguments for notify Client Operation
Unicode and UTF-8 Strings in Client Library
Client Library Interface Reference
Client Entry Interface Reference
SILC Math Library
SILC MP Interface
SILC Math Interface
SILC Application Utility Library
SILC Application Utilities
SILC ID Cache Interface
SILC Key Repository Library
SILC SKR Interface
SILC ASN.1 Library
SILC ASN.1 Interface
SILC BER interface
SILC Key Exchange Library
SILC SKE Interface
SILC Connection Authentication Interface
SILC SFTP Library
SILC SFTP Interface
SFTP Filesystems Interface
SILC Core Library
SILC Authentication Interface
SILC Message Interface
SILC Channel Interface
SILC Command Interface
SILC Notify Interface
SILC Status Types
SILC Modes
SILC ID Interface
SILC Argument Interface
SILC Attributes Interface
Packet Engine Interface
SILC Public Key Payload Interface
SILC Utility Library
Basic Types and Definitions
Data Buffer Interface
Data Buffer Format Interface
Hash Table Interface
Memory Allocation Interface
Data Stack (memory pool) Interface
Finite State Machine Interface
Thread Interface
Mutual Exclusion Lock Interface
Condition Variable Interface
Atomic Operations Interface
Network (TCP and UDP) Interface
Scheduler Interface
Asynchronous Operation Interface
Abstract Stream Interface
Socket Stream Interface
File Descriptor Stream Interface
File Utility Functions
String Utility Interface
Snprintf Interface
UTF-8 String Interface
Stringprep Interface
Utility Functions
List Interface
Dynamic List Interface
MIME Interface
Time Utility Functions
Logging Interface
Config File Interface
SILC HTTP Library
SILC HTTP Server Interface
SILC HTTP PHP Translator
Resource Links
SILC Project Website
SILC Protocol Documentation
SILC White Paper
SILC FAQs

Function silc_argument_get_decoded
SYNOPSIS

        SilcBool silc_argument_get_decoded(SilcArgumentPayload payload,
                                           SilcUInt32 type,
                                           SilcArgumentDecodeType dec_type,
                                           void *ret_arg,
                                           void *ret_arg_alloc);

DESCRIPTION

        Returns decoded argument by type.  This is a helper function to
        decode common argument types directly.  The `type' is the argument
        type number in the payload, and the `dec_type' is the type the
        argument is decoded to.  If the `ret_arg' is non-NULL then the
        decodec data is returned into that pointer.  If the `ret_arg_alloc'
        is non-NULL then this function will allocate the decoded data and
        will return the pointer into `ret_arg_alloc'.  Some types must always
        be allocated; see SilcArgumentDecodeType.

        Return TRUE if the argument was present and waa successfully decoded.
        FALSE if it is not present, or could not be decoded.

EXAMPLE

        SilcID id;
        SilcPublicKey public_key;

        if (!silc_argument_get_decoded(args, 2, SILC_ARGUMENT_ID, &id, NULL))
          error;

        if (!silc_argument_get_decoded(args, 4, SILC_ARGUMENT_PUBLIC_KEY,
                                       NULL, &public_key))
          error;

SILC Argument Interface
SilcArgumentPayload
silc_argument_payload_parse
silc_argument_payload_encode
silc_argument_payload_encode_one
silc_argument_payload_encode_payload
silc_argument_payload_free
silc_argument_get_arg_num
silc_argument_get_first_arg
silc_argument_get_next_arg
silc_argument_get_arg_type
SilcArgumentDecodeType
silc_argument_get_decoded
silc_argument_list_parse
SilcArgumentDecodedList
silc_argument_list_parse_decoded
silc_argument_list_free

Copyright © 2001 - 2007 SILC Project SILC Project Website | SILC Toolkit Reference Manual Index