VCAddCurrentEntityUserDataByte

Version:

1.2

Description:

Adds a byte to the end of the user data to the current entity.

Declaration:

C/C++

extern "C" void WINAPI VCAddCurrentEntityUserDataByte(short* iError, BYTE b);

Delphi

procedure VCAddCurrentEntityUserDataByte(var iError: Smallint; b: Smallint); stdcall;

ActiveX/COM

Sub AddCurrentEntityUserDataByte(ByVal b As Byte)

Parameters:

b - the byte of data to add.

Notes:

User data may be attached to any drawing entity or a drawing header and used for storage of entity information, drawing information, custom settings, or indices to external tables. User data may be of the C variable types double, float, long, or short. In addition to these types, a user defined type of "chunk" may also be stored. A chunk may be any size and is simply a pointer to a memory location. The size of the chunk is also passed so Visual CADD™ can retrieve the appropriate amount of data from the specified memory location. Whenever using user data, an application must set a user data name in order to protect private data and to ensure that different applications do not interfere with the others data. VCSetUserDataName is provided for this purpose, while VCGetUserDataName checks the currently set user data name. The VCAddCurrentEntityUserData* calls always append the new variable as the last user data variable. The VCSetCurrentEntityUserData* calls add the user data variable at the index specified in the call, provided that there are indeed that many indices already attached, and overwrite any existing user data at that index. As previously mentioned, user data may be attached to the drawing header. This is achieved by using VCSetHeaderUserData and then attaching the appropriate user data. Once VCSetEntityUserData, VCFirstEntity, VCNextEntity, or any other current entity selections are used, the user data calls will again be used on the current entity.