Share via

XtfConsoleFieldId Enumeration

  • Article

Identifies the value to return from XtfGetConsoleFieldValue.

Syntax

typedef enum XtfConsoleFieldId
{
    ToolsIpAddress,
    ConsoleIPAddress,
    AccessKey,
    ConsoleId,
    CertType,
    HostName,
    DeviceId,
    SystemMajorVersion,
    SystemMinorVersion,
    SystemBuildVersion,
    SystemRevisionVersion,
    MaximumConsoleFieldId
} XtfConsoleFieldId;

Constants

Constant Description
ToolsIpAddress Tools IP address (IPv4 by default, IPv6 if the console is on an IPv6-only network).
ConsoleIPAddress Console IP address (IPv4 by default, IPv6 if the console is on an IPV6-only network).
AccessKey Console access key
ConsoleId Console ID
CertType Reserved for internal use.
HostName Console host name
DeviceId Console device ID
SystemMajorVersion System major version
SystemMinorVersion System minor version
SystemBuildVersion System build version
SystemRevisionVersion System revision version
MaximumConsoleFieldId Maximum console field ID

Remarks

This enumeration indicates which console field value is returned by the XtfGetConsoleFieldValue function. Use the value returned in the fieldType parameter of that function to identify the type of the returned console field value. For more information about console settings, see Managing console settings (NDA topic).

Requirements

Header: xtfapi.h

Library: xtfapi.lib

Supported platforms: Windows (for Xbox console tools)

See also

XtfConsoleFieldType Enumeration
Additional Xtf APIs
Xbox Tools Framework native API reference