id3dxeffectcompiler--getliteral.md

description	ms.assetid	title	ms.topic	ms.date	topic_type	api_name	api_type	api_location
Gets a literal status of a parameter. A literal parameter has a value that doesn't change during the lifetime of an effect.	417abbee-5193-462e-b0d1-b4928ad0a041	ID3DXEffectCompiler::GetLiteral method (D3DX9Shader.h)	reference	05/31/2018	APIRef kbSyntax	ID3DXEffectCompiler.GetLiteral	COM	D3dx9.lib D3dx9.dll

ID3DXEffectCompiler::GetLiteral method

Gets a literal status of a parameter. A literal parameter has a value that doesn't change during the lifetime of an effect.

Syntax

HRESULT GetLiteral(
  [in]  D3DXHANDLE hParameter,
  [out] BOOL       *pLiteral
);

Parameters

hParameter [in]

Type: D3DXHANDLE

Unique identifier to a parameter. See Handles (Direct3D 9).

pLiteral [out]

Type: BOOL*

Returns True if the parameter is a literal, and False otherwise.

Return value

Type: HRESULT

If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL.

Remarks

This methods only changes whether the parameter is a literal or not. To change the value of a parameter, use a method like ID3DXBaseEffect::SetBool or ID3DXBaseEffect::SetValue.

Requirements

Requirement	Value
Header	D3DX9Shader.h
Library	D3dx9.lib

See also

ID3DXEffectCompiler

Usages and Literals (Direct3D 9)

ID3DXEffectCompiler::SetLiteral