VCGetCurrentEntityUserDataString
VCSetCurrentEntityUserDataString


Version:

2.0

Description:

User data may be attached to any drawing entity or to the drawing header and used for storage of entity information, drawing information, custom settings, or indices to external tables. This data can be assigned and retrieved from entities based on the data type and the specified index.

Declaration:

 

C/C++

extern "C" void WINAPI VCGetCurrentEntityUserDataString(short* iError, short iIndex, char* str);
extern "C" void WINAPI VCSetCurrentEntityUserDataString(short* iError, short iIndex, char* str);

Delphi

procedure VCGetCurrentEntityUserDataString(var iError: Smallint; iIndex: Smallint; str: PAnsiChar); stdcall;
procedure VCSetCurrentEntityUserDataString(var iError: Smallint; iIndex: Smallint; str: PAnsiChar); stdcall;

ActiveX/COM

Function GetCurrentEntityUserDataString(ByVal iIndex As Integer) As String
Sub SetCurrentEntityUserDataString(ByVal iIndex As Integer, ByVal str As String)

Parameters:

iIndex - the index number within the current entity where the string should be stored.
str
- the user data string

Notes:

When using other than the ActiveX/COM versions of VCGetCurrentEntityUserDataString, the str parameter must point to an adequately sized buffer to receive the string.  The required buffer size can be determined with VCGetCurEntUserDataStringSize().

See Also:

VCAddCurrentEntityUserDataChunk, VCAddCurrentEntityUserDataByte, VCAddCurrentEntityUserDataDouble, VCAddCurrentEntityUserDataFloat, VCAddCurrentEntityUserDataLong, VCAddCurrentEntityUserDataShort, VCGetUserDataName, VCGetCurrentEntityUID,VCGetCurrentEntityUserDataByte, VCGetCurrentEntityUserDataChunk, VCGetCurrentEntityUserDataCount, VCGetCurrentEntityUserDataDouble, VCGetCurrentEntityUserDataKind, VCGetCurrentEntityUserDataLong, VCGetCurrentEntityUserDataFloat, VCGetCurrentEntityUserDataShort, VCGetCurEntUserDataChunkSize, VCSetEntityUserData, VCSetHeaderUserData