VCGetCurEntUserDataStringSize


Version:

2.0

Description:

Retrieves the string size of a user data string value.

Declaration:

 

C/C++

extern "C" short WINAPI VCGetCurEntUserDataStringSize(short* iError, short iIndex);

Delphi

function VCGetCurEntUserDataStringSize(var iError: Smallint; iIndex: Smallint):Smallint; stdcall;

ActiveX/COM

Function GetCurEntUserDataStringSize(ByVal iIndex As Integer) As Integer

Parameters:

iIndex - the index of the chunk user data.
Returns
- the size in bytes of the specified chunk.

Notes:

When retrieving user data from drawing entities, the type of user data must be determined using VCGetCurrentEntityUserDataKind. If it happens to be a chunk or string, it could be data of any size. To determine the size of the data in order to provide a correctly sized variable use VCGetCurEntUserDataChunkSize or VCGetCurEntUserDataStringSize. After the variable has been created at the right size, the data can be retrieved with VCGetCurrentEntityUserDataChunk or VCGetCurrentEntityUserDataString.

See Also:

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