VCGetUserDataName
VCSetUserDataName


Version:

1.2

Description:

User Data requires an application name to define a storage segment for the attached data.

Declaration:

 

C/C++

extern "C" short WINAPI VCGetUserDataName(short* iError, char* pS);
extern "C" void WINAPI VCSetUserDataName(short* iError, char* pS);

Delphi

function VCGetUserDataName(var iError: Smallint; pS: PAnsiChar):Smallint; stdcall;
procedure VCSetUserDataName(var iError: Smallint; pS: PAnsiChar); stdcall;

ActiveX/COM

Function GetUserDataName() As String
Sub SetUserDataName(ByVal pS As String)

Parameters:

pS - the name returned as the current registered user data name

Notes:

This name must be used in order to retrieve or edit the attached data. Once a name has been set using VCSetUserDataName, the corresponding data can only be retrieved using the current User Data name. This prevents unauthorized use of another applications User Data and accidental misuse or editing of another applications User Data. VCGetUserDataName returns the currently active User Data segment. 3rd party developers should contact TriTools Partners at devsupport@tritools.com for a unique user data name.

See Also:

VCAddCurrentEntityUserDataByte, VCAddCurrentEntityUserDataChunk, VCAddCurrentEntityUserDataDouble, VCAddCurrentEntityUserDataFloat, VCAddCurrentEntityUserDataLong, VCAddCurrentEntityUserDataShort