GetFile Method for a Business Component

The GetFile method gets a file from the Siebel file system and places that file in the local file system on the Siebel Server or the Siebel client. This method returns one of the following values:

• Operation succeeded. Returns a string that contains Success, OutFilePath.

  where:

  OutFilePath is the fully qualified path to the file that resides in the user temp folder on the Siebel client or on the Siebel Server.

• Operation failed. Returns a string that contains Error.

Format

BusComp.InvokeMethod("GetFile", KeyFieldName)

The following table describes the arguments for the GetFile method.

Argument	Description
KeyFieldName	The name of the business component field that contains the file name. For example, AccntFileName in the Account Attachment business component.

Usage for the GetFile Method

The record pointer must point to the record you seek. If necessary, you must query for the record ID, using the NextRecord method to advance through the returned set of records until the record pointer points to the record you seek.

Used With

To use this method, you can use a BusComp.InvokeMethod call with the following interfaces:

• COM Data Control

• COM Data Server

• Siebel Java Data Bean

• Mobile Web Client Automation Server

• Server Script

Examples

The following example uses Siebel VB:

Dim RetValue as String
Dim fileBC as BusComp

'Instantiate fileBC as the appropriate attachment business component
'Query for the required attachment record

RetValue = fileBC.InvokeMethod ("GetFile", "AccntFileName")

The following example uses Siebel eScript:

var RetValue;
var fileBC;

// Instantiate fileBC as the appropriate attachment business component
// Query for the required attachment record

var RetValue = fileBC.InvokeMethod("GetFile", "AccntFileName");

The following example uses COM Data Control:

Dim errCode as Integer
Dim Args as String
Dim RetValue as String
Dim fileBC as BusComp

'Instantiate fileBC as the appropriate attachment business component
'Query for the required attachment record

Args = "AccntFileName"
RetValue = fileBC.InvokeMethod ("GetFile", Args, errCode)