Brief Index      Full Index      Events Index      I.M. Reference

Show_User_Options_Length

Functions

void Show_User_Options_Length (int *length)
void Show_One_User_Option_Length (const char *which, int *length)
void PShow_One_Net_User_Opt_Len (int count, const HC_KEY *keys, const char *which, int *length)

Function Documentation

void Show_User_Options_Length ( int *  length)

Determines string length for proper buffer allocation on a call to Show_User_Options.

Parameters:
length- length of the user options string for a given segment. Passed by reference. Returned to user.

DETAILS

This function allows users to allocate an appropriately sized string before making a call to Show_User_Options() .

NOTES

The size of user option strings is controlled by the "C string length" System_Option and so the length will not exceed that length. The default C string length in 3dGS is approximately 16 million.

RESTRICTIONS

See also:
Show_User_Options
void Show_One_User_Option_Length ( const char *  which,
int *  length 
)

Similar to Show_User_Options_Length(), but returns the value of a single attribute in the currently open segment.

Parameters:
which- a particular user option
length- length of the user options string for a given segment. Passed by reference. Returned to user.

DETAILS

No additional details. See Show_User_Options_Length()

void PShow_One_Net_User_Opt_Len ( int  count,
const HC_KEY *  keys,
const char *  which,
int *  length 
)

Similar to Show_User_Options_Length(), but returns the net effective value of a single attribute along a path of segments specified by an array of HC_KEY's.

Parameters:
count- size of the keys array
keys- The list of keys starting with the owning segment and following back to some desired segment.
which- a particular user option
length- length of the user options string for a given segment. Passed by reference. Returned to user.

DETAILS

By default, HOOPS will determine the Net attribute from the last specified key all the way to the root. If you add -1 at the end of the array, the PShow_Net routines will not proceed beyond the end of the last specified key. For additional details, see Show_User_Options_Length().

Brief Index      Full Index      Events Index      I.M. Reference