ExportClient Methods

The ExportClient object contains the following methods:

GetParams
SetParams
Setup
Update

GetParams

The GetParams method retrieves the most recently saved parameters as an XML.

Syntax

GetParams() As String

Example

The following example retrieves the parameters saved in Setup and saves them to a file.

Copy

GetParams

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
Sub
    Dim fso
    Set fso = CreateObject("Scripting.FileSystemObject")
     
    Const strFileName = "C:\CxExport_settings.xml"
     
    ' ------Read parameters from file------
    Dim strParams, fileParams
    Set fileParams = fso.OpenTextFile(strFileName, 1, True)
     
    On Error Resume Next
    strParams = fileParams.ReadAll
    fileParams.Close
    MsgBox strParams
     
    ' ------Set initial export parameters------
    If Len(strParams) > 0 Then
        ExportClient.SetParams(strParams)
    End If
     
    ' ------Launch setup dialog, initialized with parameters------
    ExportClient.Setup()
     
    ' ------Get new parameters and save to file------
    strParams = ExportClient.GetParams()
     
    MsgBox strParams
     
    Set fileParams = fso.OpenTextFile(strFileName, 2, True)
    fileParams.WriteLine(strParams)
    fileParams.Close
     
    ' ------Do the actual export------
    ExportClient.Update()
End Sub

SetParams

The SetParams method sets the export parameters as an XML string.

Syntax

SetParams(strSetup As String)

Parameters

Parameter	Required	Description
strSetup	Yes	An XML string representing the parameters to set.

Example

The following example reads and sets export parameters from a file.

Copy

SetParams

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
Sub 
    Dim fso
    Set fso = CreateObject("Scripting.FileSystemObject")
     
    Const strFileName = "C:\CxExport_settings.xml"
     
    ' ------Read parameters from file------
    Dim strParams, fileParams
    Set fileParams = fso.OpenTextFile(strFileName, 1, True)
     
    On Error Resume Next
    strParams = fileParams.ReadAll
    fileParams.Close
    MsgBox strParams
     
    ' ------Set initial export parameters------
    If Len(strParams) > 0 Then
        ExportClient.SetParams(strParams)
    End If
     
    ' ------Launch setup dialog, initialized with parameters------
    ExportClient.Setup()
     
    ' ------Get new parameters and save to file------
    strParams = ExportClient.GetParams()
    MsgBox strParams
     
    Set fileParams = fso.OpenTextFile(strFileName, 2, True)
    fileParams.WriteLine(strParams)
    fileParams.Close
     
    ' ------Do the actual export------
    ExportClient.Update()
End Sub

Setup

The Setup method launches a Setup dialog box, used to configure export parameters.

Syntax

Setup() As Boolean

Remarks

This method returns True if the export parameters were modified, otherwise False.

Example

The following example launches a Setup dialog box before performing an export.

Copy

Setup

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
Sub
    Dim fso
    Set fso = CreateObject("Scripting.FileSystemObject")
     
    Const strFileName = "C:\CxExport_settings.xml"
     
    ' ------Read parameters from file------
    Dim strParams, fileParams
    Set fileParams = fso.OpenTextFile(strFileName, 1, True)
     
    On Error Resume Next
    strParams = fileParams.ReadAll
    fileParams.Close
    MsgBox strParams
     
    ' ------Set initial export parameters------
    If Len(strParams) > 0 Then
        ExportClient.SetParams(strParams)
    End If
     
    ' ------Launch setup dialog, initialized with parameters------
    ExportClient.Setup()
     
    ' ------Get new parameters and save to file------
    strParams = ExportClient.GetParams()
    MsgBox strParams
     
    Set fileParams = fso.OpenTextFile(strFileName, 2, True)
    fileParams.WriteLine(strParams)
    fileParams.Close
     
    ' ------Do the actual export------
    ExportClient.Update()
End Sub

Update

The Update method exports data according to parameters set using SetParams or Setup.

Syntax

Update() As String

Remarks

This method returns the name of the file to which the data was exported.

Example

The following example performs an export after prompting the user for parameters.

Copy

Update

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
Sub
    Dim fso
    Set fso = CreateObject("Scripting.FileSystemObject")
     
    Const strFileName = "C:\CxExport_settings.xml"
     
    ' ------Read parameters from file------
    Dim strParams, fileParams
    Set fileParams = fso.OpenTextFile(strFileName, 1, True)
     
    On Error Resume Next
    strParams = fileParams.ReadAll
    fileParams.Close
    MsgBox strParams
     
    ' ------Set initial export parameters------
    If Len(strParams) > 0 Then
        ExportClient.SetParams(strParams)
    End If
     
    ' ------Launch setup dialog, initialized with parameters------
    ExportClient.Setup()
     
    ' ------Get new parameters and save to file------
    strParams = ExportClient.GetParams()
    MsgBox strParams
     
    Set fileParams = fso.OpenTextFile(strFileName, 2, True)
    fileParams.WriteLine(strParams)
    fileParams.Close
     
    ' ------Do the actual export------
    ExportClient.Update()
End Sub