_AlpHsExternalID Struct Reference
[Data Types]

#include <hs_common.h>


Detailed Description

Represents an ID external to ALP.

This struct is used to represent an ID external to ALP. Because the external ID can be anything, such as an int, string, binary object, etc, it is defined as a void*.

Remarks:
The void* buffer is must be allocated and freed by the calling application. When reading an external ID, the buffer must be large enough to hold the external ID.


Data Fields

int16_t buff_size
 The size of this buffer, in bytes.
void * external_id
 A pointer to a buffer that contains the actual external ID.
int16_t id_size
 The size of the external ID, in bytes. It must not exceed the buffer size.


Field Documentation

int16_t buff_size
 

The size of this buffer, in bytes.

void* external_id
 

A pointer to a buffer that contains the actual external ID.

int16_t id_size
 

The size of the external ID, in bytes. It must not exceed the buffer size.


The documentation for this struct was generated from the following file:
Generated on Wed Jul 30 07:06:41 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.