Glasswall Configuration Functions

Functions

• int GWFileConfigGet(wchar_t **configurationBuffer, size_t *outputLength)
• int GWFileConfigRevertToDefaults (void)
• int GWFileConfigXML (wchar_t *xmlstring)
• int GWGetAllIdInfo (size_t *bufferLength, void **outputBuffer)
• int GWGetIdInfo (uint32_t issueId, size_t *bufferLength, void **outputBuffer)

These functions enable the operation of the Glasswall processing to be configured. Glasswall library Configuration can be updated using GWFileConfigXML().

Functions are provided to retrieve the current configuration, and to reset the current configuration to Glasswall default values.

Glasswall is single threaded.

GWFileConfigGet

int GWFileConfigGet (wchar_t ** configurationBuffer, size_t * outputLength)

This function retrieves the current Glasswall library configuration via an XML string that conforms to the Configuration Management XSD.

In the event of an error configurationBuffer will be returned as a NULL pointer and outputLength will be set to zero.

Parameters

Returns

• eGwFileStatus

GWFileConfigRevertToDefaults

int GWFileConfigRevertToDefaults (void)

This function reverts the Glasswall library's active configuration to the hard-coded default values, which is everything set to allow. This function removes any changes introduced by calls to GWFileConfigXML().

Returns

• eGwFileStatus

This example code demonstrates the library configuration being reset to default values, which are then retrieved and printed by the client application

// configuration buffer and length 
wchar_t *configurationBuffer	= NULL; 
size_t configurationBufferLength = 0;

if (eGwFileStatus_Success == GWFileConfigRevertToDefaults())
{
    if(eGwFileStatus_Success == GWFileConfigGet(&configurationBuffer, 
&configurationBufferLength))
    { 
           printLibraryConfig(configurationBuffer, configurationBufferLength);
    }
    else
    {
           // error handling
    }
}
else
{
     // error handling
}

// release resources including the global buffer 'fileImage' 
GWFileDone();

GWFileConfigXML

int GWFileConfigXML (wchar_t * xmlstring)

This function applies the given content management settings to the Glasswall library, which are later used when processing files. The content management settings are specified as a XML string that conforms to the Configuration Management XSD.

This function should be called before any documents are processed. If this function is not called, then the content management settings will be left in their default state where everything is set to allow. Content management switches that have not been specified will not be updated and will remain in their existing state.

Returns

• eGwFileStatus

This example code demonstrates the required library configuration string being collected by the client application and used to configure the Glasswall library prior to processing a PDF document.

// managed file output buffer and length 
void *fileImage	= NULL;
size_t fileImageLength = 0;

// Library configuration
wchar_t* cmPolicy = getClientApplicationConfigurationXML();

if (eGwFileStatus_Success == GWFileConfigXML(cmPolicy))
{
if(eGwFileStatus_Success == GWFileProtect(L"C:\\data\\temp1.pdf", L"pdf", 
&fileImage, &fileImageLength))
    {
        // process the managed file image
    }
}
else
{
// error handling
}

// release resources including the global buffer 'fileImage' 
GWFileDone();

GWGetAllIdInfo

int GWGetAllIdInfo (size_t * bufferLength, void ** outputBuffer)

This function returns a buffer containing an XML file populated with issue ID description for all issue ID ranges

<gw:IssueInformationGroups>
   <gw:IssueInformationGroup>
       <gw:IssueIDRangeStart>100728832</gw:IssueIDRangeStart>
       <gw:IssueIDRangeEnd>100794367</gw:IssueIDRangeEnd>
       <gw:GroupDescription>Enhanced Metafile Format Instances</gw:GroupDescription>
   </gw:IssueInformationGroup>
   <gw:IssueInformationGroup>
       <gw:IssueIDRangeStart>100859904</gw:IssueIDRangeStart>
       <gw:IssueIDRangeEnd>100925439</gw:IssueIDRangeEnd>
       <gw:GroupDescription>Emf Bitmaps Instances</gw:GroupDescription>
   </gw:IssueInformationGroup>
...
</gw:IssueInformationGroups>

Parameters

Returns

• eGwFileStatus / Process Return Status

GWGetIdInfo

int GWGetIdInfo (uint32_t I, size_t * bufferLength, void ** outputBuffer)

This function returns a buffer containing the description for the given issue ID.

Parameters

Returns

• eGwFileStatus / Process Return Status