# SSC R2.4.17 Web Services API

## Generated by IDLdoc

single page | use frames summary class fields routine details file attributes

## ./

# spdfsscfileresult__define.pro

This class is an IDL representation of the FileResult element from the Satellite Situation Center (SSC) XML schema.

## Author information

Author

  B. Harris

Copyright

  Copyright (c) 2014 United States Government as represented by the National Aeronautics and Space Administration. No copyright is claimed in the United States under Title 17, U.S.Code. All Other Rights Reserved.

## Class description for SpdfSscFileResult

### Inheritance

- SpdfResult

### Properties

#### Properties in SpdfSscFileResult

statusCode init
statusSubCode init
statusText init

## Routines

### Methods inherited from SpdfResult

- `result = SpdfResult::getStatusCode()`
- `result = SpdfResult::getStatusSubCode()`
- `result = SpdfResult::init(statusCode=string, statusSubCode=string, statusText=strarr)`
- `SpdfResult::cleanup`
- `SpdfResult::print`
- `result = SpdfResult::getStatusText()`

### Routines from spdfsscfileresult__define.pro

`result = SpdfSscFileResult::init(files, statusCode=string, statusSubCode=string, statusText=strarr)`

  Creates an SpdfSscFileResult object.

`SpdfSscFileResult::cleanup`

  Performs cleanup operations when this object is destroyed.

`result = SpdfSscFileResult::getFiles()`

  Gets the files.

`SpdfSscFileResult__define`

  Defines the SpdfSscFileResult class.

## Routine details

## top source SpdfSscFileResult::init

`result = SpdfSscFileResult::init(files, statusCode=string, statusSubCode=string, statusText=strarr)`

Creates an SpdfSscFileResult object.

### Return value

reference to an SpdfSscFileResult object.

### Parameters

files in type=SpdfFileDescription objarr

  result files.

### Keywords

statusCode in type=string

  result status code.

statusSubCode in type=string

  result status sub-code.

statusText in type=strarr

  result status text.

## top source SpdfSscFileResult::cleanup

`SpdfSscFileResult::cleanup`

Performs cleanup operations when this object is destroyed.

## top source SpdfSscFileResult::getFiles

`result = SpdfSscFileResult::getFiles()`

Gets the files.

### Return value

a reference to objarr of FileDescriptions.

## top source SpdfSscFileResult__define

`SpdfSscFileResult__define`

Defines the SpdfSscFileResult class.

## File attributes

Modification date: | Fri May 13 08:54:13 2022
Lines: | 28

SSC Feedback.