Brief Index      Full Index      I.M. Reference

Show_One_User_Data


Functions

long Show_One_User_Data (POINTER_SIZED_INT index, void *data, long data_length)
long QShow_One_User_Data (char const *sname, POINTER_SIZED_INT index, void *data, long data_length)
long Show_One_User_Data_By_Key (Key key, POINTER_SIZED_INT index, void *data, long data_length)
long Show_One_Net_User_Data (POINTER_SIZED_INT index, void *data, long data_length)
long PShow_One_Net_User_Data (int count, Key const *keys, POINTER_SIZED_INT index, void *data, long data_length)
long QShow_One_Net_User_Data (char const *sname, POINTER_SIZED_INT index, void *data, long data_length)
long Show_User_Data_Indices (POINTER_SIZED_INT *data_indices, long data_indices_count)
long Show_User_Data_Indices_By_Key (Key key, POINTER_SIZED_INT *data_indices, long data_indices_count)
long QShow_User_Data_Indices (char const *sname, POINTER_SIZED_INT *data_indices, long data_indices_count)

Function Documentation

long Show_One_User_Data ( POINTER_SIZED_INT  index,
void *  data,
long  data_length 
)

Returns the user data that has been set on the currently open segment and associated with a specific unique index.

Parameters:
index - A unique indentifier associated with the user data.
data - A pointer to a buffer which can be populated with binary data associated with the index.
data_length - The size of the data buffer being passed.
Returns:
  • 0 if no matching index was found.
  • A negative number if the data found was too large for the buffer. The absolute value is the actual size of the user data.
  • A positive number if the data found and written into the passed data buffer. The return value indicate the size of the data.

DETAILS

No additional details. Seet Set_User_Data().

NOTES

The Show_One_User_Data routines return the actual attribute data buffer stored in the particular segment at hand. The Show_Net_User_Data routines return the effective user data value for the specified segment. The distinction is that there may or may not be an "actual" stored value for the user data at a given segment, but there is guaranteed always to be an effective value for every attribute for every segment.

long QShow_One_User_Data ( char const *  sname,
POINTER_SIZED_INT  index,
void *  data,
long  data_length 
)

Similar to Show_One_User_Data() except that it returns data for a specifically named segment.

Parameters:
sname - the name of the segment in which the user data should be shown.
index - A unique indentifier associated with the user data.
data - A pointer to a buffer which can be populated with binary data associated with the index.
data_length - The size of the data buffere beings passed.
Returns:
  • 0 if no matching index was found.
  • A negative number if the data found was too large for the buffer. The absolute value is the actual size of the user data.
  • A positive number if the data found and written into the passed data buffer. The return value indicates the size of the data.

DETAILS

No additional details. Seet Set_User_Data().

long Show_One_User_Data_By_Key ( Key  key,
POINTER_SIZED_INT  index,
void *  data,
long  data_length 
)

Similar to Show_One_User_Data() except that it returns data for a segment associated with the passed key.

Parameters:
key - the key in which the user data should be shown.
index - A unique indentifier associated with the user data.
data - A pointer to a buffer which can be populated with binary data associated with the index.
data_length - The size of the data buffere beings passed.
Returns:
  • 0 if no matching index was found.
  • A negative number if the data found was too large for the buffer. The absolute value is the actual size of the user data.
  • A positive number if the data found and written into the passed data buffer. The return value indicate the size of the data.

DETAILS

No additional details. Seet Set_User_Data().

long Show_One_Net_User_Data ( POINTER_SIZED_INT  index,
void *  data,
long  data_length 
)

Similar to Show_One_User_Data() except that it returns the net effective user data.

Parameters:
index - A unique indentifier associated with the user data.
data - A pointer to a buffer which can be populated with binary data associated with the index.
data_length - The size of the data buffere beings passed.
Returns:
  • 0 if no matching index was found.
  • A negative number if the data found was too large for the buffer. The absolute value is the actual size of the user data.
  • A positive number if the data found and written into the passed data buffer. The return value indicates the size of the data.

DETAILS

No additional details. Seet Set_User_Data().

long PShow_One_Net_User_Data ( int  count,
Key const *  keys,
POINTER_SIZED_INT  index,
void *  data,
long  data_length 
)

Similar to Show_One_Net_User_Data() but returns the net effective settings along a discrete segment path.

Parameters:
count - The size of keys
keys - An array of HC_KEY's delineating a path of segments.
index - A unique indentifier associated with the user data.
data - A pointer to a buffer which can be populated with binary data associated with the index.
data_length - The size of the data buffere beings passed.
Returns:
  • 0 if no matching index was found.
  • A negative number if the data found was too large for the buffer. The absolute value is the actual size of the user data.
  • A positive number if the data found and written into the passed data buffer. The return value indicates the size of the data.

DETAILS

No additional details. Seet Set_User_Data().

long QShow_One_Net_User_Data ( char const *  sname,
POINTER_SIZED_INT  index,
void *  data,
long  data_length 
)

Similar to Show_One_Net_User_Data() but operates on a given segment rather than the currently open one.

Parameters:
sname - the name of the segment in which the user data should be set.
index - A unique indentifier associated with the user data.
data - A pointer to a buffer which can be populated with binary data associated with the index.
data_length - The size of the data buffere beings passed.

DETAILS

No additional details. Seet Set_User_Data().

long Show_User_Data_Indices ( POINTER_SIZED_INT *  data_indices,
long  data_indices_count 
)

Returns the list of user data indices associated with the current segment.

Parameters:
data_indices - A pointer to a buffer which can be populated with a list of indices.
data_indices_count - The size of data_indices buffer.
Returns:
  • 0 if no indices were found.
  • A negative number if the data found was too large for the buffer. The absolute value is the actual size of the user data.
  • A positive number if the data found and written into the passed data buffer. The return value indicates the size of the data.

DETAILS

No additional details. Seet Set_User_Data().

long Show_User_Data_Indices_By_Key ( Key  key,
POINTER_SIZED_INT *  data_indices,
long  data_indices_count 
)

Similar to Show_User_Data_Indices() but returns information for the segment associated with the passed key.

Parameters:
key - the key in which the user data indices should be show.
data_indices - A pointer to a buffer which can be populated with a list of indices.
data_indices_count - The size of data_indices buffer.
Returns:
  • 0 if no indices were found.
  • A negative number if the data found was too large for the buffer. The absolute value is the actual size of the user data.
  • A positive number if the data found and written into the passed data buffer. The return value indicates the size of the data.

DETAILS

No additional details. Seet Set_User_Data().

long QShow_User_Data_Indices ( char const *  sname,
POINTER_SIZED_INT *  data_indices,
long  data_indices_count 
)

Similar to Show_User_Data_Indices() but returns information for the named segment.

Parameters:
sname - the name of the segment in which the user data indices should be shown.
data_indices - A pointer to a buffer which can be populated with a list of indices.
data_indices_count - The size of data_indices buffer.
Returns:
  • 0 if no indices were found.
  • A negative number if the data found was too large for the buffer. The absolute value is the actual size of the user data.
  • A positive number if the data found and written into the passed data buffer. The return value indicates the size of the data.

DETAILS

No additional details. Seet Set_User_Data().

Main Index
Brief Index      Full Index      I.M. Functions