BSKGetTokenDescription

void BSKGetTokenDescription( BSKTokenId type, 
                             BSKCHAR* buffer,
                             BSKUI32 length );

• type - the token type that is to be described.
• buffer - the buffer that will contain the description.
• length - the size of the buffer.

Description: Retrieves a description of the given token. For token "classes", (like TT_STRING, TT_BOOLEAN, TT_NUMBER, and TT_DICE) this is just a description of the class, not the actual data. For the keyword and punctation tokens, this is the actual keyword or punctuation. No more than 'length' bytes are copied into the buffer.

Return to the API
Return to the function listing