SUMMARY: NESTED | FIELD | | METHOD
DETAIL: FIELD | METHOD

Class IPS_ScreenSettingData

CIM_ManagedElement
   extended by CIM_SettingData
      extended by IPS_ScreenSettingData


class IPS_ScreenSettingData
 extends CIM_SettingData


General Information:
The IPS_ScreenSettingData class represents 
Extended Displays Configuration settings for KVM redirection service in the 
Intel(R) 
AMT.

Qualifiers:
-------------
Version=8.0.0









  
  

    Supported Fields 
      Summary

  

     string 
      
    ElementName 
The 
      user-friendly name for this instance of SettingData . . .

  

     string 
      
    InstanceID Key  
Within the scope of the instantiating Namespace, 
      InstanceID opaquely and uniquely identifies an instance of this class . . 
      .

  

     uint8 
      
    PrimaryIndex 
The 
      display with the start button . . .

  

     uint8 
      
    SecondaryIndex 
      
The secondary display according to GFX driver 

  

     uint8 
      
    TertiaryIndex 
The 
      tertiary display according to GFX driver 

  

     uint8 
      
    QuadraryIndex 
The 
      quadrary display according to GFX driver 

  

     boolean[4] 
      
    IsActive 
Represent if 
      screen[i] is present

  

     sint32[4] 
      
    UpperLeftX 
Upper 
      left X coordinate of screen[i] . . .

  

     sint32[4] 
      
    UpperLeftY 
Upper 
      left Y coordinate of screen[i] . . .

  

     uint32[4] 
      
    ResolutionX 
X 
      resolution of screen[i]

  

     uint32[4] 
      
    ResolutionY 
Y 
      resolution of screen[i]




  
  

    Methods Summary

  

     uint32
    ResetToDefault() 
      
This API resets the extended display configuration settings

  

     
    Put(Instance) 
Changes 
      properties of the selected instance

  

     
    Get(Instance) 
Gets the 
      representation of the instance

  

     
    Pull(EnumerationContext, 
      MaxElements) 
Pulls instances of this class, following an 
      Enumerate operation

  

     
    Enumerate() 
      
Enumerates the instances of this class

  

     
    Release(EnumerationContext) 
      
Releases an enumeration context




  
  

    Field 
Detail


ElementName 
public string ElementName



  
General Information:
The user-friendly name for this instance of 
  SettingData. In addition, the user-friendly name can be used as an index 
  property for a search or query. (Note: The name does not have to be unique 
  within a 
  namespace.)

Qualifiers:
-------------
Required
Override=ElementName
MaxLen=256


  

  





InstanceID Key 
public string InstanceID



  
General Information:
Within the scope of the instantiating 
  Namespace, InstanceID opaquely and uniquely identifies an instance of this 
  class. To ensure uniqueness within the NameSpace, the value of InstanceID 
  should be constructed using the following "preferred" algorithm: 
  
<OrgID>:<LocalID> 
Where <OrgID> and <LocalID> 
  are separated by a colon (:), and where <OrgID> must include a 
  copyrighted, trademarked, or otherwise unique name that is owned by the 
  business entity that is creating or defining the InstanceID or that is a 
  registered ID assigned to the business entity by a recognized global 
  authority. (This requirement is similar to the <Schema Name>_<Class 
  Name> structure of Schema class names.) In addition, to ensure uniqueness, 
  <OrgID> must not contain a colon (:). When using this algorithm, the 
  first colon to appear in InstanceID must appear between <OrgID> and 
  <LocalID>. 
<LocalID> is chosen by the business entity and 
  should not be reused to identify different underlying (real-world) elements. 
  If the above "preferred" algorithm is not used, the defining entity must 
  assure that the resulting InstanceID is not reused across any InstanceIDs 
  produced by this or other providers for the NameSpace of this instance. 
  
For DMTF-defined instances, the "preferred" algorithm must be used with 
  the <OrgID> set to 
  CIM.

Qualifiers:
-------------
Key
Override=InstanceID
MaxLen=256


  

  





PrimaryIndex 
public uint8 PrimaryIndex



  
General Information:
The display with the start button. When 
  working in extended display mode, this display have (0,0) coordinates as 
  left-upper corner

Qualifiers:
-------------
ValueMap={0, 
  1, 2, 3, 4..254, 255}
Values={Pipe0, Pipe1, Pipe2, Pipe3, Reserved, 
  Unknown}


  

  





SecondaryIndex 
public uint8 SecondaryIndex



  
General Information:
The secondary display according to GFX 
  driver 

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 
  4..254, 255}
Values={Pipe0, Pipe1, Pipe2, Pipe3, Reserved, Unknown}


  

  





TertiaryIndex 
public uint8 TertiaryIndex



  
General Information:
The tertiary display according to GFX 
  driver 

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 
  4..254, 255}
Values={Pipe0, Pipe1, Pipe2, Pipe3, Reserved, Unknown}


  

  





QuadraryIndex 
public uint8 QuadraryIndex



  
General Information:
The quadrary display according to GFX 
  driver 

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 
  4..254, 255}
Values={Pipe0, Pipe1, Pipe2, Pipe3, Reserved, Unknown}


  

  





IsActive 
public boolean[4] IsActive



  
General Information:
Represent if screen[i] is present

  

  





UpperLeftX 
public sint32[4] UpperLeftX



  
General Information:
Upper left X coordinate of screen[i]. Shall 
  be set to 0 for primary display.Can be negative

  

  





UpperLeftY 
public sint32[4] UpperLeftY



  
General Information:
Upper left Y coordinate of screen[i]. Shall 
  be set to 0 for primary display.Can be negative

  

  





ResolutionX 
public uint32[4] ResolutionX



  
General Information:
X resolution of screen[i]

  

  





ResolutionY 
public uint32[4] ResolutionY



  
General Information:
Y resolution of screen[i]

  

  






  
  

    Method 
Detail


ResetToDefault
public uint32 ResetToDefault()



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_ADMINISTRATION_REALM, 
  ADMIN_SECURITY_SOLIDER_REALM

General Information:
This API 
  resets the extended display configuration 
  settings

Qualifiers:
-------------
ValueMap={0, 
  1}
Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR}






Put
public  Put([IN]IPS_ScreenSettingData Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_LOCAL_SYSTEM_REALM

General 
  Information:
Changes properties of the selected 
  instance

Product Specific Usage:
The following properties 
  must be included in any representation of IPS_ScreenSettingData: 
  
ElementName 
InstanceID 






Get
public  Get([OUT]IPS_ScreenSettingData Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_GENERAL_INFO_REALM

General Information:
Gets 
  the representation of the instance





Pull
public  Pull([IN]String EnumerationContext, [IN]String MaxElements)



  
Permission Information:
All users permitted to use method, only 
  instances to whom the user has permissions will be returned

General 
  Information:
Pulls instances of this class, following an Enumerate 
  operation





Enumerate
public  Enumerate()



  
Permission Information:
All users permitted to use 
  method

General Information:
Enumerates the instances of this 
  class





Release
public  Release([IN]String EnumerationContext)



  
Permission Information:
All users permitted to use 
  method

General Information:
Releases an enumeration 
  context






  
  

    SUMMARY: NESTED | FIELD | METHOD
  

  

    DETAIL: FIELD | METHOD



  
  

    
      
Copyright © 2006-2022, Intel 
      Corporation. All rights 
reserved.