ID3D10Include::Close method

  • Article

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

Syntax

HRESULT Close(
  [in] LPCVOID pData
);

Parameters

  • pData [in]
    Type: LPCVOID

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

Return value

Type: HRESULT

The user-implemented method should return S_OK. If the callback fails when reading the #include file, the application programming interface (API) that caused the callback to be called will fail. This is one of the following:

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

Remarks

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

The ID3D10Include interface is type defined in the D3D10Shader.h header file as a ID3DInclude interface, which is fully defined in the D3DCommon.h header file.

typedef interface ID3DInclude ID3D10Include;

Requirements

Header

 D3D10Shader.h

See also

ID3D10Include Interface

ID3D10Include::Open