![[attach.png]](idldoc-resources/attach.png)
./
spdfsscfiledescription__define.pro
This class is an IDL representation of the FileDescription element from the File Situation Center (SSC) XML schema.
Author information
- Author
B. Harris
- Copyright
Copyright (c) 2014-2024 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 SpdfSscFileDescription
Routines
Routines from spdfsscfiledescription__define.pro
result = SpdfSscFileDescription::init(name, mimeType, length, lastModified)Creates an SpdfSscFileDescription object.
SpdfSscFileDescription::cleanupPerforms cleanup operations when this object is destroyed.
result = SpdfSscFileDescription::getName()Gets the name of the file.
result = SpdfSscFileDescription::getMimeType()Gets the MIME type of the file.
result = SpdfSscFileDescription::getLength()Gets the length of the file.
result = SpdfSscFileDescription::getLastModified()Gets the last modified time.
SpdfSscFileDescription::printPrints a textual representation of this object.
result = SpdfSscFileDescription::getFile( [/buffer] [, filename=string] [, /string_array] [, callback_function=string] [, callback_data=reference] [, sslVerifyPeer=int])Retrieves this file from a remote HTTP or FTP server and writes it to disk, a memory buffer, or an array of strings.
SpdfSscFileDescription__defineDefines the SpdfSscFileDescription class.
Routine details
top source SpdfSscFileDescription::init
result = SpdfSscFileDescription::init(name, mimeType, length, lastModified)
Creates an SpdfSscFileDescription object. If access to the Internet is through an HTTP proxy, the caller should ensure that the HTTP_PROXY environment is correctly set before this method is called. The HTTP_PROXY value should be of the form http://username:password@hostname:port/.
Return value
reference to an SpdfSscFileDescription object.
Parameters
- name in type=string
file name.
- mimeType in type=string
file's MIME type.
- length in type=int
file's size in bytes.
- lastModified in type=julday
time of last modification to file.
top source SpdfSscFileDescription::cleanup
SpdfSscFileDescription::cleanup
Performs cleanup operations when this object is destroyed.
top source SpdfSscFileDescription::getName
result = SpdfSscFileDescription::getName()
Gets the name of the file.
Return value
name of the file.
top source SpdfSscFileDescription::getMimeType
result = SpdfSscFileDescription::getMimeType()
Gets the MIME type of the file.
Return value
MIME type of the file.
top source SpdfSscFileDescription::getLength
result = SpdfSscFileDescription::getLength()
Gets the length of the file.
Return value
length of the file.
top source SpdfSscFileDescription::getLastModified
result = SpdfSscFileDescription::getLastModified()
Gets the last modified time.
Return value
last modified time.
top source SpdfSscFileDescription::print
SpdfSscFileDescription::print
Prints a textual representation of this object.
top source SpdfSscFileDescription::getFile
result = SpdfSscFileDescription::getFile( [/buffer] [, filename=string] [, /string_array] [, callback_function=string] [, callback_data=reference] [, sslVerifyPeer=int])
Retrieves this file from a remote HTTP or FTP server and writes it to disk, a memory buffer, or an array of strings. The returned data is written to disk in the location specified by the FILENAME keyword. If the filename is not specified, the local name will be the same as this file's name in the current working directory.
Return value
one of the following: A string containing the full path of the file retrieved from the remote HTTP or FTP server, A byte vector, if the BUFFER keyword is set, An array of strings, if the STRING_ARRAY keyword is set, A null string, if no data were returned by the method.
Keywords
- buffer in optional type=boolean default=false
if this keyword is set, the return value is a buffer and the FILENAME keyword is ignored.
- filename in optional type=string
set this keyword equal to a string that holds the file name and path where the retrieved file is locally stored. If FILENAME specifies a full path, the file is stored in the specified path. If FILENAME specifies a relative path, the path is relative to IDL's current working directory. If FILENAME is not present the file is stored in the current working directory under the name the basename of filename. If FILENAME is the same between calls, the last file received is overwritten.
- string_array in optional type=boolean default=false
set this keyword to treat the return value as an array of strings. If this keyword is set, the FILENAME and BUFFER keywords are ignored.
- callback_function in optional type=string
this keyword value is the name of the IDL function that is to be called during this retrieval operation. The callbacks provide feedback to the user about the ongoing operation, as well as provide a method to cancel an ongoing operation. If this keyword is not set, no callback to the caller is made. For information on creating a callback function, see "Using Callbacks with the IDLnetURL Object" in the IDL documentation.
- callback_data in optional type=reference
this keyword value contains data that is passed to the caller when a callback is made. The data contained in this variable is defined and set by the caller. The variable is passed, unmodified, directly to the caller as a parameter in the callback function. If this keyword is not set, the corresponding callback parameter's value is undefined.
- sslVerifyPeer in optional type=int default=1
Specifies whether the authenticity of the peer's SSL certificate should be verified. When 0, the connection succeeds regardless of what the peer SSL certificate contains.
File attributes
| Modification date: | Tue Jan 16 12:59:02 2024 |
| Lines: | 90 |
SSC Feedback.