# Complete SSC R2.4.17 Web Services API

## Generated by IDLdoc

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

## ./

# spdfresult__define.pro

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

## Author information

Author

  B. Harris

Copyright

  Copyright (c) 2013 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 SpdfResult

Subclasses: SpdfSscDataResult SpdfSscFileResult

### Properties

#### Properties in SpdfResult

statusCode init
statusSubCode init
statusText init

### Fields

#### Fields in SpdfResult

statusCode ''

  result status code.

statusSubCode ''

  result status sub-code.

statusText ptr_new()

  result status text.

## Routines

### Routines from spdfresult__define.pro

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

  Creates an SpdfResult object.

`SpdfResult::cleanup`

  Performs cleanup operations when this object is destroyed.

`result = SpdfResult::getStatusCode()`

  Gets the status code value.

`result = SpdfResult::getStatusSubCode()`

  Gets the status sub-code value.

`result = SpdfResult::getStatusText()`

  Gets the status text.

`SpdfResult::print`

  Prints a textual representation of this object.

`SpdfResult__define`

  Defines the SpdfResult class.

## Routine details

## top source SpdfResult::init

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

Creates an SpdfResult object.

### Return value

reference to an SpdfResult object.

### 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 SpdfResult::cleanup

`SpdfResult::cleanup`

Performs cleanup operations when this object is destroyed.

## top source SpdfResult::getStatusCode

`result = SpdfResult::getStatusCode()`

Gets the status code value.

### Return value

status code value.

## top source SpdfResult::getStatusSubCode

`result = SpdfResult::getStatusSubCode()`

Gets the status sub-code value.

### Return value

status sub-code value.

## top source SpdfResult::getStatusText

`result = SpdfResult::getStatusText()`

Gets the status text.

### Return value

a reference to strarr of status text.

## top source SpdfResult::print

`SpdfResult::print`

Prints a textual representation of this object.

## top source SpdfResult__define

`SpdfResult__define`

Defines the SpdfResult class.

## File attributes

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

SSC Feedback.