file element

Article
04/26/2021

Directs the code generator to generate a file and specifies the output file name.

Usage

<file
  name = "pathname string">
  child elements
</file>

Attributes

Attribute	Type	Required	Description
name	pathname string	Yes	The output filename for the generated content. The filename string should include complete path information.

Child elements

Element	Description
CDATA	Text and CDATA sections are copied to the file without modification. Source code that is not a function of the contract input data can be added to output files using text and CDATA sections.
enumerationValueDeclarations	Generates C declarations for values of all enumerated types.
eventSourceBuilderDeclarations	Generates declarations for functions that create event source classes.
eventSourceBuilderImplementations	Generates functions that create event source classes.
functionDeclarations	Generates implementation declarations for proxy functions for port type operations.
hostBuilderDeclaration	Generates a declaration for a function that creates a typed host.
hostBuilderImplementation	Generates a function that creates a typed host.
idlFunctionDeclarations	Generates IDL declarations for proxy functions for port type operations.
include	Includes the contents of a macro or file in the generated output.
IUnknownDeclarations	Generates declarations for QueryInterface, AddRef and Release.
IUnknownDefinitions	Generates implementations for QueryInterface, AddRef and Release.
literalInclude	Places a C or IDL include statement in the generated code.
messageStructureDefinitions	Generates C structure definitions for message types.
messageTypeDeclarations	Generates C constant declarations for XML schema tables for message types.
messageTypeDefinitions	Generates C constants for XML schema tables for message types.
namespaceDeclarations	Generates C declarations for namespace tables.
namespaceDefinitions	Generates C definitions for namespace tables.
portTypeDeclarations	Generates C constant declarations for port types.
portTypeDefinitions	Generates C constants for port types.
proxyBuilderDeclarations	Generates declarations for functions to create typed proxies.
proxyBuilderImplementations	Generates functions to create typed proxies.
proxyFunctionImplementations	Generates implementations for proxy functions for port type operations.
relationshipMetadataDeclaration	Generates a forward declaration for the hosting metadata specified in the hostMetadata element.
relationshipMetadataDefinition	Generates a C constant definition for the hosting metadata specified in the hostMetadata element.
structDeclarations	Generates C structure declarations for known types.
structDefinitions	Generates C structure definitions for known types.
stubDeclarations	Generates declarations for stub functions for port type operations.
stubDefinitions	Generates implementations for stub functions for port type operations.
subscriptionFunctionDeclarations	Generates implementation declarations for subscribe/unsubscribe proxy functions for port type notification operations.
subscriptionIdlFunctionDeclarations	Generates IDL declarations for subscribe/unsubscribe proxy functions for port type notification operations.
subscriptionProxyFunctionImplementations	Generates implementations for subscribe/unsubscribe proxy functions for port type notification operations.
text	Text and CDATA sections are copied to the file without modification. Source code that is not a function of the contract input data can be added to output files using text and CDATA sections.
thisModelMetadataDeclaration	Generates a forward declaration for the C constant for the manufacturer metadata specified in the thisModelMetadata element.
thisModelMetadataDefinition	Generates a C constant for the manufacturer metadata specified in the thisModelMetadata element.
typeTableDeclarations	Generates C constant declarations for XML schema tables for known types.
typeTableDefinitions	Generates C constants for XML schema tables for known types.

Child element sequence

(
  text, 
  CDATA, 
  namespaceDeclarations*, 
  namespaceDefinitions*, 
  structDeclarations*, 
  structDefinitions*, 
  typeTableDeclarations*, 
  typeTableDefinitions*, 
  thisModelMetadataDeclaration*, 
  thisModelMetadataDefinition*, 
  portTypeDeclarations*, 
  portTypeDefinitions*, 
  messageStructureDefinitions*, 
  messageTypeDeclarations*, 
  messageTypeDefinitions*, 
  idlFunctionDeclarations*, 
  subscriptionIdlFunctionDeclarations*, 
  functionDeclarations*, 
  subscriptionFunctionDeclarations*, 
  proxyFunctionImplementations*, 
  subscriptionProxyFunctionImplementations*, 
  stubDeclarations*, 
  stubDefinitions*, 
  enumerationValueDeclarations*, 
  include*, 
  IUnknownDeclarations*, 
  IUnknownDefinitions*, 
  relationshipMetadataDeclaration*, 
  relationshipMetadataDefinition*, 
  proxyBuilderDeclarations*, 
  proxyBuilderImplementations*, 
  hostBuilderDeclaration*, 
  hostBuilderImplementation*, 
  eventSourceBuilderDeclarations*, 
  eventSourceBuilderImplementations*, 
  literalInclude*
)

Parent elements

Element	Description
wsdCodeGen	The root element of an WSDAPI code generator XML script file.

Remarks

The name of the file is determined by the value of the name attribute or child element. The content of the file is determined by the other child elements, text and CDATA in the file element. Text and CDATA are copied to the file unmodified. Child elements are replaced with generated code. Text, CDATA and child elements may occur in any order and may be repeated indefinitely.

Element information

Label	Value
Minimum supported system	Windows Vista
Can be empty	No

Share via