ActionFormat Class (Microsoft.DirectX.DirectInput)

Article
06/29/2006

Contains information about the calling application and acts as a container for an array of Diaction structures that define action-to-control mappings for a genre.

Definition

Visual Basic Public Class ActionFormat
Inherits Object

C# public class ActionFormat : Object

C++ public ref class ActionFormat : Object

JScript public class ActionFormat extends Object

Members Table

The following table lists the members exposed by the object.

Methods

Method Description

ActionFormat Initializes a new instance of the object.

Finalize Called during garbage collection. If implemented, allows an object to free resources before it is destroyed by the garbage collector.

Properties

Property Description

ActionMap GUID that identifies the action map. Device manufacturers can use this value to tune mappings for a specific title.

ActionMapGuid GUID that identifies the action map. Device manufacturers can use this value to tune mappings for a specific title.

Actions Collection of actions.

AxisMax Maximum value for the range of scaled data to be returned for all axes. This value is ignored for a specific action axis if the DIA_NORANGE flag is set in Diaction.dwFlags. This value is valid only for axis actions and should be set to zero for all other actions. It is used as the Diproprange.lMax value to set the range property on an absolute axis when the action map is applied using Inputdevice9Setactionmap.

AxisMin Minimum value for the range of scaled data to be returned for all axes. This value is ignored for a specific action axis if the DIA_NORANGE flag is set in Diaction.dwFlags. This value is valid only for axis actions and should be set to zero for all other actions. It is used as the Diproprange.lMin value to set the range property on an absolute axis when the action map is applied using Inputdevice9Setactionmap.

BufferSize Retrieves or sets a value that specifies the number of input data packets in the buffer for each device to which this action-to-control mapping is to be applied.

Genre DWORD value that specifies the genre of the application. For possible values, see ActionMappingConstants.

Instance Handle of the module containing string resources for action names, as specified in the uResIdString member of the Diaction structure for each action. Can be zero if action names are specified in the lptszActionName member of the Diaction structure for each action.

InstanceHandle Handle of the module containing string resources for action names.

TimeStamp FILETIME structure that receives the time at which this action map was last written to disk. See Remarks.

Method	Description
ActionFormat	Initializes a new instance of the object.
Finalize	Called during garbage collection. If implemented, allows an object to free resources before it is destroyed by the garbage collector.

Property	Description
ActionMap	GUID that identifies the action map. Device manufacturers can use this value to tune mappings for a specific title.
ActionMapGuid	GUID that identifies the action map. Device manufacturers can use this value to tune mappings for a specific title.
Actions	Collection of actions.
AxisMax	Maximum value for the range of scaled data to be returned for all axes. This value is ignored for a specific action axis if the DIA_NORANGE flag is set in Diaction.dwFlags. This value is valid only for axis actions and should be set to zero for all other actions. It is used as the Diproprange.lMax value to set the range property on an absolute axis when the action map is applied using Inputdevice9Setactionmap.
AxisMin	Minimum value for the range of scaled data to be returned for all axes. This value is ignored for a specific action axis if the DIA_NORANGE flag is set in Diaction.dwFlags. This value is valid only for axis actions and should be set to zero for all other actions. It is used as the Diproprange.lMin value to set the range property on an absolute axis when the action map is applied using Inputdevice9Setactionmap.
BufferSize	Retrieves or sets a value that specifies the number of input data packets in the buffer for each device to which this action-to-control mapping is to be applied.
Genre	DWORD value that specifies the genre of the application. For possible values, see ActionMappingConstants.
Instance	Handle of the module containing string resources for action names, as specified in the uResIdString member of the Diaction structure for each action. Can be zero if action names are specified in the lptszActionName member of the Diaction structure for each action.
InstanceHandle	Handle of the module containing string resources for action names.
TimeStamp	FILETIME structure that receives the time at which this action map was last written to disk. See Remarks.

Inheritance Hierarchy

Object

ActionFormat

Class Information

Namespace Microsoft.DirectX.DirectInput

Assembly Microsoft.DirectX.DirectInput (microsoft.directx.directinput.dll)

Strong Name Microsoft.DirectX.DirectInput, Version=1.0.900.0, Culture=neutral, PublicKeyToken=d3231b57b74a1492

Visual Basic	Public Class ActionFormat Inherits Object
C#	public class ActionFormat : Object
C++	public ref class ActionFormat : Object
JScript	public class ActionFormat extends Object

Namespace	Microsoft.DirectX.DirectInput
Assembly	Microsoft.DirectX.DirectInput (microsoft.directx.directinput.dll)
Strong Name	Microsoft.DirectX.DirectInput, Version=1.0.900.0, Culture=neutral, PublicKeyToken=d3231b57b74a1492

ActionFormat Class (Microsoft.DirectX.DirectInput)

Additional resources