SetSPFFHeaderItem

This call can be used to write a specific header item, the source code example is larger to show and explain how this call can be used.

Syntax

C++ 32 bit

C++ 64 bit

C# 32 bit

C# 64 bit

public const string enginedll = @"engine.dll";

[DllImport(enginedll, EntryPoint = "SetSPFFHeaderItem")]
public static extern Int64 x86_SetSPFFHeaderItem(Int32 model, Int32 itemIndex, Int32 itemSubIndex, Int32 valueType, out IntPtr value);

[DllImport(enginedll, EntryPoint = "SetSPFFHeaderItem")]
public static extern Int64 x64_SetSPFFHeaderItem(Int64 model, Int64 itemIndex, Int64 itemSubIndex, Int64 valueType, out IntPtr value);

public static Int64 SetSPFFHeaderItem(Int64 model, Int64 itemIndex, Int64 itemSubIndex, Int64 valueType, out IntPtr value)
		{
			if (IntPtr.Size == 4)
			{
				var _result = x86_SetSPFFHeaderItem((Int32)model, (Int32)itemIndex, (Int32)itemSubIndex, (Int32)valueType, out IntPtr _value);
				value = _value;
				return _result;
			}
			else
			{
				return x64_SetSPFFHeaderItem(model, itemIndex, itemSubIndex, valueType, out value);
			}
		}

Property model

Size: 64 bit / 8 byte (value)
The handle to the model. The model handle is static during its existance. Several models can be opened simultaniously within one session. Different models are always independent, threads are allowed to be running on different models simultaniously.

Property itemIndex

Size: 64 bit / 8 byte (value)
...

Property itemSubIndex

Size: 64 bit / 8 byte (value)
...

Property valueType

Size: 64 bit / 8 byte (value)
...

Property value

Size: 64 bit / 8 byte (reference)
...

Example (based on pure API calls)

Here you can find code snippits that show how the API call SetSPFFHeaderItem can be used.

using RDF;      //  include at least engine.cs within your solution

string ifcFileName = "myFileName", timeStamp = "current date and time";

...
...

//  set Description
ifcengine.SetSPFFHeaderItem(model, 0, 0, ifcengine.sdaiUNICODE, System.Text.Encoding.Unicode.GetBytes("ViewDefinition [CoordinationView]"));
ifcengine.SetSPFFHeaderItem(model, 0, 1, ifcengine.sdaiSTRING, null as string);
//  set Implementation Level
ifcengine.SetSPFFHeaderItem(model, 1, 0, ifcengine.sdaiSTRING, System.Text.Encoding.UTF8.GetBytes("2;1"));
//  set Name
ifcengine.SetSPFFHeaderItem(model, 2, 0, ifcengine.sdaiUNICODE, System.Text.Encoding.Unicode.GetBytes(ifcFileName));
//  set Time Stamp
ifcengine.SetSPFFHeaderItem(model, 3, 0, ifcengine.sdaiUNICODE, System.Text.Encoding.Unicode.GetBytes(timeStamp));
//  set Author
ifcengine.SetSPFFHeaderItem(model, 4, 0, ifcengine.sdaiUNICODE, System.Text.Encoding.UTF8.GetBytes("Architect"));  //  It is allowed to mix sdaiUNICODE and sdaiSTRING
ifcengine.SetSPFFHeaderItem(model, 4, 1, ifcengine.sdaiSTRING, null as string);                                    //  as long as each call is consitent in itself.
//  set Organization
ifcengine.SetSPFFHeaderItem(model, 5, 0, ifcengine.sdaiSTRING, System.Text.Encoding.UTF8.GetBytes("Building Designer Office"));
//  set Preprocessor Version
ifcengine.SetSPFFHeaderItem(model, 6, 0, ifcengine.sdaiSTRING, System.Text.Encoding.UTF8.GetBytes("IFC Engine DLL"));
//  set Originating System
ifcengine.SetSPFFHeaderItem(model, 7, 0, ifcengine.sdaiSTRING, System.Text.Encoding.UTF8.GetBytes("Documentation Example"));
//  set Authorization
ifcengine.SetSPFFHeaderItem(model, 8, 0, ifcengine.sdaiSTRING, System.Text.Encoding.UTF8.GetBytes("The authorising person"));
//  set File Schema
ifcengine.SetSPFFHeaderItem(model, 9, 0, ifcengine.sdaiSTRING, System.Text.Encoding.UTF8.GetBytes("IFC4"));
ifcengine.SetSPFFHeaderItem(model, 9, 1, ifcengine.sdaiSTRING, null as string);