Class EOS_UserInfo_BestDisplayName
java.lang.Object
com.sun.jna.Structure
host.anzo.eossdk.eos.sdk.userinfo.EOS_UserInfo_BestDisplayName
- All Implemented Interfaces:
AutoCloseable
- Direct Known Subclasses:
EOS_UserInfo_BestDisplayName.ByReference,EOS_UserInfo_BestDisplayName.ByValue
@FieldOrder({"ApiVersion","UserId","DisplayName","DisplayNameSanitized","Nickname","PlatformType"})
public class EOS_UserInfo_BestDisplayName
extends com.sun.jna.Structure
implements AutoCloseable
A structure that contains the user information. These structures are created by EOS_UserInfo_CopyBestDisplayName or
EOS_UserInfo_CopyBestDisplayNameWithPlatform and must be passed to EOS_UserInfo_BestDisplayName_Release.
- Since:
- 9/3/2023
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classNested classes/interfaces inherited from class com.sun.jna.Structure
com.sun.jna.Structure.FieldOrder, com.sun.jna.Structure.StructField -
Field Summary
FieldsModifier and TypeFieldDescriptionintAPI Version: Set this to EOS_USERINFO_BESTDISPLAYNAME_API_LATEST.The display name (un-sanitized).The raw display name (sanitized).static final intA nickname/alias for the target user assigned by the local user.The platform type for the user which corresponds to the display nameThe Epic Account ID of the userFields inherited from class com.sun.jna.Structure
ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE -
Constructor Summary
Constructors -
Method Summary
Methods inherited from class com.sun.jna.Structure
allocateMemory, allocateMemory, autoAllocate, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, calculateSize, clear, createFieldsOrder, createFieldsOrder, createFieldsOrder, createFieldsOrder, dataEquals, dataEquals, ensureAllocated, equals, fieldOffset, getAutoRead, getAutoWrite, getFieldList, getFieldOrder, getFields, getNativeAlignment, getNativeSize, getNativeSize, getPointer, getStringEncoding, getStructAlignment, hashCode, newInstance, newInstance, read, readField, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setStringEncoding, size, sortFields, toArray, toArray, toString, toString, useMemory, useMemory, write, writeField, writeField, writeField
-
Field Details
-
EOS_USERINFO_BESTDISPLAYNAME_API_LATEST
public static final int EOS_USERINFO_BESTDISPLAYNAME_API_LATEST- See Also:
-
ApiVersion
public int ApiVersionAPI Version: Set this to EOS_USERINFO_BESTDISPLAYNAME_API_LATEST. -
UserId
The Epic Account ID of the user -
DisplayName
The display name (un-sanitized). This may be null -
DisplayNameSanitized
The raw display name (sanitized). This may be null -
Nickname
A nickname/alias for the target user assigned by the local user. This may be null -
PlatformType
The platform type for the user which corresponds to the display name
-
-
Constructor Details
-
EOS_UserInfo_BestDisplayName
public EOS_UserInfo_BestDisplayName() -
EOS_UserInfo_BestDisplayName
public EOS_UserInfo_BestDisplayName(com.sun.jna.Pointer peer)
-
-
Method Details
-
release
public void release()Release the memory associated with EOS_UserInfo_BestDisplayName. This must be called on data retrieved from EOS_UserInfo_CopyBestDisplayNameWithPlatform. -
close
- Specified by:
closein interfaceAutoCloseable- Throws:
Exception
-