ID3DXInclude::Open

A user-implemented method for opening and reading the contents of a shader #include file.

HRESULT Open(
  D3DXINCLUDE_TYPE IncludeType,
  LPCSTR pFileName,
  LPCVOID pParentData,
  LPCVOID * ppData,
  UINT * pBytes
);

Parameters

IncludeType

[in] The location of the #include file. See D3DXINCLUDE_TYPE.

pFileName

[in] Name of the #include file.

pParentData

[in] Pointer to the container that includes the #include file.

ppData

[out] Pointer to the returned buffer that contains the include directives. This pointer remains valid until ID3DXInclude::Close is called.

pBytes

[out] Number of bytes returned in ppData.

Return Values

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

• The HLSL shader will fail one of the D3DXCompileShader*** functions.
• The assembly shader will fail one of the D3DXAssembleShader*** functions.
• The effect will fail one of the D3DXCreateEffect*** or D3DXCreateEffectCompiler*** functions.

Requirements

Header: Declared in D3dx9shader.h.

See Also

ID3DXInclude::Close