VCSetHeaderUserData

Version:

1.2

Description:

Sets the user data section to the drawing header for attaching user data.

Declaration:

C/C++

extern "C" void WINAPI VCSetHeaderUserData(short* iError);

Delphi

procedure VCSetHeaderUserData(var iError: Smallint); stdcall;

ActiveX/COM

Sub SetHeaderUserData()

Parameters:

No additional parameters are used with this subroutine.

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.

As a 3rd party developer, you should contact TriTools Partners to be assigned a unique user data name that will not collide with other apps on a users system where they might have multiple 3rd party applications employing user data.

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. User data is always attached to the current entity which is set using VCFirstEntity, VCNextEntity, VCFirstSelected, VCNextSelected or VCSetCurrentEntity.

As previously mentioned, user data may be attached to any drawing entity or a drawing header. User data is attached to the drawing header by calling VCSetHeaderUserData and then attaching the appropriate user data. User data is attached to a drawing entity by calling VCSetEntityUserData to use the current entity and then attaching the appropriate user data. Calling VCFirstEntity, VCNextEntity, or any other current entity selections will automatically set the user data to use the new current entity without requiring VCSetEntityUserData.