X-Git-Url: http://git.silcnet.org/gitweb/?p=website.git;a=blobdiff_plain;f=docs%2Ftoolkit%2Fmanual%2Fsilcattrs-silc_attribute_get_object.html;fp=docs%2Ftoolkit%2Fmanual%2Fsilcattrs-silc_attribute_get_object.html;h=6aa6133c23fefecfa311a0f796648d97eb3ee0cb;hp=0000000000000000000000000000000000000000;hb=80b80cef93d9dff6acc4bc8e3a522c55fcdc3fca;hpb=43e53f529ca5c7d2ddb7cee8e76e273631e6f1e2 diff --git a/docs/toolkit/manual/silcattrs-silc_attribute_get_object.html b/docs/toolkit/manual/silcattrs-silc_attribute_get_object.html new file mode 100644 index 0000000..6aa6133 --- /dev/null +++ b/docs/toolkit/manual/silcattrs-silc_attribute_get_object.html @@ -0,0 +1,263 @@ + + + + + + + + + + + + + + + + + + + +
Copyright © 2001 - 2007 SILC Project
+ SILC Project Website		 + SILC Toolkit Reference Manual
+ Index
+ + +
+ + + + + + + + + + + + + + +
+ + + +
+
+ + + +SILC Toolkit Reference Manual
+ + +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 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 Key Exchange Library
+    SILC SKE Interface
+    SILC Connection Authentication Interface
+SILC VCard Library
+    SILC VCard Interface
+SILC Math Library
+    SILC MP Interface
+    SILC Math 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 ASN.1 Library
+    SILC ASN.1 Interface
+    SILC BER interface
+SILC HTTP Library
+    SILC HTTP Server Interface
+    SILC HTTP PHP Translator
+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 Key Repository Library
+    SILC SKR Interface
+SILC Application Utility Library
+    SILC Application Utilities
+    SILC ID Cache Interface
+SILC SFTP Library
+    SILC SFTP Interface
+    SFTP Filesystems Interface
+ +
+Resource Links +
+SILC Project Website
+SILC Protocol Documentation
+SILC White Paper
+SILC FAQs
+ + +



+
+ 		+ + + + +
+
+ +Function silc_attribute_get_object

+ + +SYNOPSIS + +

+    SilcBool silc_attribute_get_object(SilcAttributePayload payload,
+                                       void *object,
+                                       SilcUInt32 object_size);
+
+
+DESCRIPTION + +

+    Returns the already parsed attribute object from the payload
+    indicated by `payload'.  Copies the data into the `object' which
+    must be sent as argument (and must be of correct type and size).
+    The `object_size' indicates the size of the `*object' sent.
+    Returns TRUE if the `attribute' attribute was found and FALSE
+    if such attribute is not present in the `payload', or the `object_size'
+    is not sufficient.  See the definition of SilcAttribute for the
+    list of attributes and the required object types for attributes.
+    You can use silc_attribute_get_attribute to get the SilcAttribute
+    type from the `payload'.
+
+
+EXAMPLE + +

+    SilcAttributeObjDevice dev;
+
+    ...
+    case SILC_ATTRIBUTE_DEVICE_INFO:
+    memset(&dev, 0, sizeof(dev));
+    if (!silc_attribute_get_object(payload, (void *)&dev, sizeof(dev)))
+      error();
+
+    case SILC_ATTRIBUTE_USER_ICON:
+    mime = silc_mime_alloc();
+    if (!silc_attribute_get_object(payload, (void *)mime, sizeof(*mime)))
+      error();
+    ...
+
+
+



+
+ 		+ + + + +
+
+ +SILC Attribute Interface
+SilcAttributePayload
+SilcAttribute
+SilcAttributeFlags
+SilcAttributeMood
+SilcAttributeContact
+SilcAttributeDevice
+SilcAttributePNFormat
+silc_attribute_payload_alloc
+silc_attribute_payload_parse
+silc_attribute_payload_encode
+silc_attribute_payload_encode_data
+silc_attribute_payload_free
+silc_attribute_payload_list_free
+silc_attribute_get_attribute
+silc_attribute_get_flags
+silc_attribute_get_data
+silc_attribute_get_verify_data
+SilcAttributeObjService
+SilcAttributeObjGeo
+SilcAttributeObjDevice
+SilcAttributeObjPk
+SilcAttributeObjPN
+silc_attribute_get_object
+ + +



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