ConstantTable.GetConstantDescription Method

Language:

Retrieves an array of constant descriptions in the constant table.

Definition

Visual Basic Public Function GetConstantDescription( _
    ByVal constant As EffectHandle, _
    ByVal numberConstants As Integer _
) As ConstantDescription()

C# public ConstantDescription[] GetConstantDescription(
    EffectHandle constant,
    int numberConstants
);

C++ public:
array<ConstantDescription>^ GetConstantDescription(
    EffectHandle^ constant,
    int numberConstants
);

JScript public function GetConstantDescription(
    constant : EffectHandle,
    numberConstants : int
) : ConstantDescription[];

Visual Basic	Public Function GetConstantDescription( _ ByVal constant As EffectHandle, _ ByVal numberConstants As Integer _ ) As ConstantDescription()
C#	public ConstantDescription[] GetConstantDescription( EffectHandle constant, int numberConstants );
C++	public: array<ConstantDescription>^ GetConstantDescription( EffectHandle^ constant, int numberConstants );
JScript	public function GetConstantDescription( constant : EffectHandle, numberConstants : int ) : ConstantDescription[];

Parameters

constant Microsoft.DirectX.Direct3D.EffectHandle
An EffectHandle class that uniquely identifies a constant.

numberConstants System.Int32
[in, out] Input supplied must be the maximum size of the array. Output is the number of elements that are filled in the array when the function returns.

Return Value

Microsoft.DirectX.Direct3D.ConstantDescription[]
Array of descriptions. For more information, see ConstantDescription.

Remarks

Because samplers can appear more than once in a constant table, this method can return an array of descriptions, each with a different register index.

Exceptions

InvalidCallException The method call is invalid. For example, a method's parameter might contain an invalid value.

InvalidDataException The data is invalid.

constant	Microsoft.DirectX.Direct3D.EffectHandle An EffectHandle class that uniquely identifies a constant.
numberConstants	System.Int32 [in, out] Input supplied must be the maximum size of the array. Output is the number of elements that are filled in the array when the function returns.

InvalidCallException	The method call is invalid. For example, a method's parameter might contain an invalid value.
InvalidDataException	The data is invalid.