BlueZone LIPI COM ObjectBlueZone LIPI Object methods and properties

BlueZone LIPI Object methods and properties

The BlueZone LIPI Object contains the following methods and properties.

  • About method
    The About method mimics the Help → About BlueZone menu option and opens the About BlueZone window.
  • AddToTransferList() method
    The AddToTransferList() method creates a new entry in the Transfer List based on the current LIPI Object settings, for example, the LocalFile and RemoteFile properties. This mimics clicking Add To List in the middle of the Host File Transfer window.
  • CenterTransferWindowOnOpen property
    The CenterTransferWindowOnOpen property gets or sets the Center Transfer Window on Open check box in the Options tab of the File Options window.
  • ClientCertificate property
    The ClientCertificate property gets or sets the Client Certificate options in the Certificate tab of the Security window.
  • ClientCertificateFileName property
    The ClientCertificateFileName property gets or sets the Certificate File or Common Name field in the Certificate tab of the Security window.
  • CollapseListWindow method
    The CollapseListWindow method mimics the View → Collapse List Window menu option.
  • CollapseTransferWindow method
    The CollapseTransferWindow method mimics the View → Collapse Transfer Window menu option.
  • CreateiSeriesDataBaseFile method
    The CreateiSeriesDataBaseFile method generates a new iSeries database file based on the settings passed into this method.
  • CreateiSeriesDataBaseFileWizard method
    The CreateiSeriesDataBaseFileWizard method mimics the Transfer → Create iSeries Database File menu option.
  • CurrentDirectory property
    The CurrentDirectory property gets or sets the current local working directory folder for the host file transfer.
  • DefaultDateFormat property
    The DefaultDateFormat property gets or sets the Date Format menu in the Data Options window.
  • DefaultDateSeparator property
    The DefaultDateSeparator property gets or sets the Date Separator menu in the Data Options window.
  • DefaultDecimalSeparator property
    The DefaultDecimalSeparator property gets or sets the Decimal Separator menu in the Data Options window.
  • DefaultTimeFormat property
    The DefaultTimeFormat property gets or sets the Time Format menu in the Data Options window.
  • DefaultTimeSeparator property
    The DefaultTimeSeparator property gets or sets the Time Separator menu in the Data Options window.
  • ErrorMessage property
    The ErrorMessage property returns the error message of the last host transfer or action performed.
  • Fields method
    The Fields method returns the Fields Object that is part of the BlueZone LIPI Object.
  • HostAuthority property
    The HostAuthority property gets or sets the Authority menu in the Host tab of the Transfer Setup window.
  • HostFDFFileName property
    The HostFDFFileName property gets or sets the FDF File Name field in the Host tab of the Transfer Setup window.
  • HostFileAction property
    The HostFileAction property gets or sets the File Creation menu in the Host tab of the Transfer Setup window.
  • HostFileText property
    The HostFileText property gets or sets the File Text field in the Host tab of the Transfer Setup window.
  • HostFileType property
    The HostFileType property gets or sets the File Type menu in the Host tab of the Transfer Setup window.
  • HostMemberText property
    The HostMemberText property gets or sets the Member Text field in the Host tab of the Transfer Setup window.
  • HostPromptBeforeReplace property
    The HostPromptBeforeReplace property gets or sets the Prompt Before Replace check box in the Host tab of the Transfer Setup window.
  • HostRecordLength property
    The HostRecordLength property gets or sets the Record Length menu in the Host tab of the Transfer Setup window.
  • HostReferenceFile property
    The HostReferenceFile property gets or sets the Reference File field in the Host tab of the Transfer Setup window.
  • HostUseDescriptionFile property
    The HostUseDescriptionFile property gets or sets the Use Description File check box in the Host tab of the Transfer Setup window.
  • EnableTracing property
    The EnableTracing property gets or sets the Enable Tracing to File check box in the Trace tab of the File Options window.
  • ExpandListWindow method
    The ExpandListWindow method mimics the View → Expand List Window menu option.
  • ExpandTransferWindow method
    The ExpandTransferWindow method mimics the View → Expand Transfer Window menu option.
  • Help method
    The Help method mimics the Help → BlueZone Help Topics menu option and opens the BlueZone Display and Printer User’s Guide.
  • HostAddress property
    The HostAddress property gets or sets the Host Address field in the Connection tab of the Transfer Setup window.
  • InvalidCertificateAction property
    The InvalidCertificateAction property gets or sets the Invalid Certificates option in the Security tab of the Security window.
  • Language property
    The Language property gets or sets the Language (CCSID) menu option in the Connection tab of the Transfer Setup window.
  • LocalDeleteTrailingSpaces property
    The LocalDeleteTrailingSpaces property gets or sets the Delete Trailing Spaces check box in the Local tab of the Transfer Setup window.
  • LocalFDFFileName property
    The LocalFDFFileName property gets or sets the FDF File Name field in the Local tab of the Transfer Setup window.
  • LocalFile property
    The LocalFile property gets or sets the current local PC file for the host file transfer.
  • LocalIfFileExists property
    The LocalIfFileExists property gets or sets the If File Exists menu in the Local tab of the Transfer Setup window.
  • LocalPromptBeforeOverwrite property
    The LocalPromptBeforeOverwrite property gets or sets the Prompt Before Overwrite check box in the Local tab of the Transfer Setup window.
  • LocalSaveDescriptionFile property
    The LocalSaveDescriptionFile property gets or sets the Save Description File check box in the Local tab of the Transfer Setup window.
  • MaxTransferListEntries property
    The MaxTransferListEntries property gets or sets the Max Transfer List Entries menu in the Options tab of the File Options window.
  • OpenSettings method
    The OpenSettings method opens the specified transfer file.
  • OutputFileType property
    The OutputFileType gets or sets the Output To menu in the Transfer tab of the Transfer Setup window.
  • Password property
    The Password property gets or sets the Password field in the Connection tab of the Transfer Setup window. For security reasons, this property will always return blank.
  • PreferredCipherSuite property
    The PreferredCipherSuite property gets or sets the Preferred CipherSuite menu option in the Security tab of the Security window.
  • PrivateKeyFileName property
    The PrivateKeyFileName property gets or sets the Private Key or Provider Name field in the Certificate tab of the Security window.
  • ReceiveFile method
    The ReceiveFile method receives the specified file from the host.
  • RemoteFile property
    The RemoteFile property gets or sets the current host file for the host file transfer.
  • RootCertificates property
    The RootCertificates property gets or sets the Root Certificates section in the Certificate tab of the Security window.
  • SaveSettings method
    The SaveSettings method saves the specified transfer file.
  • SaveSettingsOnClose property
    The SaveSettingsOnClose property gets or sets the Save Settings On Close option in the Options tab of the File Options window.
  • SaveTransferListOnClose property
    The SaveTransferListOnClose property gets or sets the Save Transfer List On Close option in the Options tab of the File Options window.
  • SendFile method
    The SendFile method sends the specified local file to the host.
  • SetWindowPos method
    The SetWindowPos method changes the size and location of the Host File Transfer window.
  • ShowGUI method
    The ShowGUI method shows the Host File Transfer window. The method does not return until you close the Host Transfer window.
  • ShowTransferStatusWindow property
    The ShowTransferStatusWindow property gets or sets the Show Transfer Status Window check box in the Transfer tab of the Transfer Setup window.
  • SQLQuery property
    The SQLQuery property gets or sets the SQL Query text in the SQL tab of the Transfer Setup window.
  • SSLVersion property
    The SSLVersion property gets or sets the SSL Version option in the Security tab of the Security window.
  • StartTrace method
    The StartTrace method start a LIPI trace.
  • StopTrace method
    The StopTrace method stops the LIPI trace if it was started.
  • SubmitCompletedTransfersToTheTransferList property
    The SubmitCompletedTransfersToTheTransferList property gets or sets the Submit Completed Transfers to the Transfer List check box in the Options tab of the File Options window.
  • TraceFileName property
    The TraceFileName property gets or sets the Trace File Name field in the Trace tab of the File Options window.
  • TransferListAdd method
    The TransferListAdd method mimics the List → Add menu option and the Transfer Properties – New Entry window opens.
  • TransferListMoveDown method
    The TransferListMoveDown method moves the specified transfer list entry down one position in the Transfer List window.
  • TransferListMoveUp method
    The TransferListMoveUp method moves the specified transfer list entry up one position in the Transfer List window.
  • TransferListNew method
    The TransferListNew method mimics the List → New menu option except that there are no prompts.
  • TransferListOpen method
    The TransferListOpen method opens the specified transfer list.
  • TransferListProperties method
    The TransferListProperties method opens the Transfer Properties window for the specified transfer list entry.
  • TransferListRemove method
    The TransferListRemove method deletes the specified transfer list entry.
  • TransferListRun method
    The TransferListRun method runs the specified transfer list entry.
  • TransferListSave method
    The TransferListSave method saves the specified transfer list.
  • TransferMethod property
    The TransferMethod property gets or sets the Transfer Method menu in the Transfer tab of the Transfer Setup window.
  • TransferSetup method
    The TransferSetup method mimics the Transfer → Transfer Setup menu option and opens the Transfer Setup window.
  • UserName property
    The UserName property gets or sets the Username field in the Connection tab of the Transfer Setup window.
  • UseSSLEncryption property
    The UseSSLEncryption property gets or sets the Enable Secure Sockets Layer check box in the Security tab of the Security window.
  • UseWindowsCredentials property
    The UseWindowsCredentials property gets or sets the Use Windows Credentials check box in the Connection tab of the Transfer Setup window.
  • Visible property
    The Visible property gets or sets the Host File Transfer window visibility.
  • WindowState property
    The WindowState property gets or sets the state of the Host File Transfer window.
Parent topic: BlueZone LIPI COM Object