SetSPFFHeader

This call is an aggregate of several SetSPFFHeaderItem calls. In several cases the header can be set easily with this call. In case an argument is zero, this argument will not be updated, i.e. it will not be filled with 0.

Syntax

//   Visual Studio for Windows
public:
void __declspec(dllexport) __stdcall SetSPFFHeader(
            __int64 model,
            char    * description,
            char    * implementationLevel,
            char    * name,
            char    * timeStamp,
            char    * author,
            char    * organization,
            char    * preprocessorVersion,
            char    * originatingSystem,
            char    * authorization,
            char    * fileSchema
        );

//   Linux, OS-X and non-Visual Studio Windows solutions
public:
void SetSPFFHeader(
            int64_t model,
            char    * description,
            char    * implementationLevel,
            char    * name,
            char    * timeStamp,
            char    * author,
            char    * organization,
            char    * preprocessorVersion,
            char    * originatingSystem,
            char    * authorization,
            char    * fileSchema
        );    

Property model

Size: 64 bit / 8 byte (value)
Handle of the model containing the IFC file, this handle is needed in many other calls and given when the model is created.

Property description

Size: 64 bit / 8 byte (reference)
The description in the header.

Property implementationLevel

Size: 64 bit / 8 byte (reference)
The implementation level in the header.

Property name

Size: 64 bit / 8 byte (reference)
The name in the header.

Property timeStamp

Size: 64 bit / 8 byte (reference)
The time stamp in the header.

Property author

Size: 64 bit / 8 byte (reference)
The author in the header.

Property organization

Size: 64 bit / 8 byte (reference)
The organization in the header.

Property preprocessorVersion

Size: 64 bit / 8 byte (reference)
The preprocessor version in the header.

Property originatingSystem

Size: 64 bit / 8 byte (reference)
The originating system in the header.

Property authorization

Size: 64 bit / 8 byte (reference)
The authorization in the header.

Property fileSchema

Size: 64 bit / 8 byte (reference)
The file schema in the header.

Examples

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

char    * ifcFileName = 0, * timeStamp = 0;

...
...

SetSPFFHeader(
            model,
            "ViewDefinition [CoordinationView]",
            "2;1",
            ifcFileName,
            timeStamp,
            "Architect",
            "Building Designer Office",
            "IFC Engine DLL",
            "Documentation Example",
            "The authorising person",
            "IFC4"
        );


OR


wchar_t * ifcFileName = 0, * timeStamp = 0;

...
...

setStringUnicode(1);
SetSPFFHeader(
            model,
            (char*) L"ViewDefinition [CoordinationView]",
            (char*) L"2;1",
            ifcFileName,
            timeStamp,
            (char*) L"Architect",
            (char*) L"Building Designer Office",
            (char*) L"IFC Engine DLL",
            (char*) L"Documentation Example",
            (char*) L"The authorising person",
            (char*) L"IFC4"
        );