Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Button handy
blanktrue
color#0052CC
nameSend Feedback
linkhttps://docs.google.com/forms/d/e/1FAIpQLScmToBe3vynAlb5fdKwCGxYqnTbDc66sIBgeecG2BuFDuHc7g/viewform?entry.2002826954=fileClose+-+15489114
widthauto

Table plus
applyColStyleToCelltrue
heading0
columnTypess,s,s,s
multiplefalse
columnAttributesstyle="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold,
enableSortingfalse

Syntax

fileClose(fid)

Package

file

...

Alias

Pkg Usage

close(

...

fid)

Description

Excerpt
hiddentrue
Closes a previously opened file and removes it from memory.
Info

Note:

If you forget to close a file (opened with fileOpen) it will be automatically closed at the end of the script. However, if you are running a script that takes a lot of time to complete, it’s not a good practice to keep it open.

...

Closes a previously opened file and removes it from memory.

Parameters

Table plus
applyColStyleToCelltrue
columnTypess,s,s,s
heading0
multiplefalse
enableSortingfalse

Parameter name

Type

Required

Description

file id

Integer

Yes

The id of a file opened from a previous step that should be closed.

Return

...

Type

None

Return value has no meaning.

Error Handling

Throws String

...

  • "invalid": if the path is invalid
  • "cannot_work_on_directory": if the path is a directory, in fact, and not a file
  • "unresolvable": if the file cannot be resolved
  • "notfound": if the file is not found

Example

Example 1

Code Block
languagejs
use "file";

int fid = open(filename); //fileOpen
fileClose(fid);//full name of the routine

...

See also

Filter by label (Content by label)
showLabelsfalse
max25
showSpacefalse
cqllabel = "file_

...

routine" and space = currentSpace ( )
labels

...

array_routines