ID3DInclude::Close method (d3dcommon.h)

  • Article

A user-implemented method for closing a shader #include file.

Syntax

HRESULT Close(
  LPCVOID pData
);

Parameters

pData

Type: LPCVOID

Pointer to the buffer that contains the include directives. This is the pointer that was returned by the corresponding ID3DInclude::Open call.

Return value

Type: HRESULT

The user-implemented Close method should return S_OK. If Close fails when it closes the #include file, the application programming interface (API) that caused Close to be called fails. This failure can occur in one of the following situations:

  • The high-level shader language (HLSL) shader fails one of the D3D10CompileShader*** functions.
  • The effect fails one of the D3D10CreateEffect*** functions.

Remarks

If ID3DInclude::Open was successful, Close is guaranteed to be called before the API using the ID3DInclude interface returns.

Requirements

Requirement Value
Target Platform Windows
Header d3dcommon.h
Library D3DCompiler.lib
DLL D3DCompiler_47.dll

See also

ID3DInclude

ID3DInclude::Open