C++ Syntax

bool

MKI_PlugInExport(

const LPCWSTR f_pszFileName,

__int32 f_nFilterMode,

__int32 f_nFlag,

const LPCWSTR f_pszCollectionName,

const LPCWSTR f_pszItemName,

void* f_pData );

typedef bool

(*MKI_PLUGINEXPORT_PROC)(

const LPCWSTR f_pszFileName,

__int32 f_nFilterMode,

__int32 f_nFlag,

const LPCWSTR f_pszCollectionName,

__int32 f_nOwnerID,

void* f_pData );

This procedure is called each time the serving application wants to save a non-MKD drawing. The plug-in should then save the drawing data in its native format.

Parameters

f_pszFileName

[const LPCWSTR] Name of the file to be created.

f_nFilterMode

[__int32] A bit-wise OR combination of special filter modes. It can be any combination of the following values:

MKI_FILTER_MODE_NULL

No special mode.

MKI_FILTER_MODE_QUIET

The export filter shall not display any messages in case of errors. This mode is used for automatic conversion or archiving processes.

f_nFlag

[__int32] This value determines which objects shall be exported to the file. If f_nFlag is zero, the complete drawing shall be exported. If f_nFlag is non-zero, only those entities shall be exported that have this flag set in header. This is usually achieved by passing this f_nFlag directly to the enumeration procedure (e.g. MKI_EnumerateAll).

f_pszCollectionName New in Version 2022.2

[const LPCWSTR] Title of the collection from which export options shall be loaded. If the collection name is MKI_BLOCK_ID, the drawing's internal collection will be accessed. May be nullptr or point to an empty string to indicate "use current settings".

f_pszItemName New in Version 2022.2

[const LPCWSTR] Name of the collection item from which export options shall be loaded. May be nullptr or point to an empty string to indicate "use current settings".

To access the options collection item chosen by the user, use f_pszCollectionName and f_pszItemName in combination with the values m_nExportOptionsOwnerID and m_nExportOptionsItemType that you stated in the MKI_PLUGIN_ID structure when your MKI_PlugInInit was called.

f_pData New in Version 2013.0

[void*] Pointer to a set of plug-in-specific export options. Please refer to the plug-in's documentation for details (both data structure and interpretation). May be nullptr to indicate "use default options".

Return Value

Should return true if the file was saved successfully, else false.

Comment

The name of the procedure has to be exactly MKI_PlugInExport.