Open a file for binary buffered I/O. The open mode
is used to indicate how the file is to be accessed.
The file format is used both to specify a default extension to use and
for the write modes, the type to be stored in the file's header. For the
read mode, a format of zero may be specified indicating no default
extension.

A native operating system file may be opened by using the
appropriate file type. For example, a format of 4 opens a text file in
the native file system.

A successful open returns a simple integer channel number. This
channel number is to be passed to the routines for reading, writing,
skipping, and closing the file.

uc4510 (read characters), uc4511 (read integers), uc4512 (read reals),
and uc4513 (read bytes) are used to read primitive data types from a
file open with uc4500. Combinations of these types may be used to
create more complex data types. The I/O channel number returned by uc4500
is passed to these other routines.

uc4520 (write characters), uc4521 (write integers), uc4522 (write
reals), and uc4523 (write bytes) are used to write primitive data types
to a file opened with uc4500. Combinations of these calls are used to
create more complex types. The I/O channel number returned by uc4500
is passed to these other routines.

uc4530 (skip characters), uc4531 (skip integers), uc4532 (skip reals),
and uc4533 (skip bytes) are used to bypass primitive data types in a
file opened with uc4500. A combination of these may be used to skip
over more complex types. Skips may be backward by using negative
skip counts.

For characters, the count will be rounded up to the next integer
boundary (e.g. a write/read/skip of 5 will actually write/read/skip 8
characters).

Return code:
<0 = error
>= 0 = i/o channel number

Internal and External

uc4510
uc4511
uc4512
uc4513
uc4520
uc4521
uc4522
uc4523
For description of modes see table
For description of file formats see table
 

gateway

Open a text file for I/O. Only the routines uc4514,
uc4524, and uc4525 for reading and writing lines may be used on text
file. See the description of uc4500 for a description of the parameters.
For omode = 4, the file must exist and will be opened for write. The
file pointer will be initially positioned at the end of file.
For omode = 6, a printer is opened. If the filespec is blank, the
default printer will be opened.

Return code:
< 0 = error
>= 0 = I/O Channel Number

Internal and External

uc4514a
uc4524
uc4525
For description of file types see table
 

gateway

Open a binary file for block I/O. Only the routines
uc4516 and uc4526 for reading and writing blocks may be used on a
file opened with uc4506. See the description of uc4500 for a
description of the parameters.

Return code:
> 0 = error
<= 0 = I/O Channel Number

Internal and External

uc4516
uc4526

For description of file types see table
 

gateway

Open a file for record oriented I/O. Only the
routines uc4517 and uc4527 may be used to read and write records.
Record I/O is generally only supported for native files.

Return code:
< 0 = error
>= 0 = I/O Channel Number

Internal and External

uc4517
uc4527
For description of file types see table
 

gateway

Open a directory for reading. Directory entries are read
using uc4518 with the fields picked out using uc4600 to uc4609.
Sub-directories may be opened using uc4509.

The dmode bit-mask is used to indicate the intention of the
application in using the directory. Bits zero through seven indicate
which fields from the file header to read and bits ten through thirteen
specify special directory options.

You can specify which bits to set by using the left shift operator in
conjuction with the bit wise or. For example, to set bits 11 and 13, you
would use the following declaration:
int dmode = (1 << 11) | (1 << 13);

A wildcard template may be used and is specified when the directory
is opened. It may be passed separate from the directory filespec or as
part of the directory filespec. For example:

dmode(bit 11) = 1, fspec = "disk/manager", wcard = ".prt" will
return out all parts in the manager's directory.

If neither dmode(bit 11) or dmode(bit 12) is set then all files will be
returned. dmode(bit 11) and dmode(bit 12) should not be
set at the same time.

If dmode(bit 13) is set then the caller is only interested in the names
of the files and none of the header attributes. If this is set then none
of the parameter dmode(bit 0) through dmode(bit 7) should be set.

If dmode(bit 10) is set then the caller is intending to open
sub-directories. If it is not set then uc4509 should not be called.

Return code:
< 0 = error
>= 0 = I/O Channel Number

Internal and External

uc4518
uc4600
uc4609
uc4509
For description of file types see table
 

gateway

Open a subdirectory of the currently open directory.
The previous directory entry read by uc4518 must have been of type
directory (format 100-112) otherwise the error 'not a directory'
is returned. Subdirectories are closed using uc4549.

Internal and External

uc4518
uc4549
 

gateway

Read characters from a file opened with uc4500.

For characters, the count will be rounded up to the next integer
boundary (e.g. a read of 5 will actually read 8 characters).
Integer variables are used for storing the characters in byte format.

Internal and External

uc4500
 

gateway

Read integers from a file opened with uc4500.

Internal and External

uc4500
 

gateway

Read reals from a file opened with uc4500.

Internal and External

uc4500
 

gateway

Read bytes from a file opened with uc4500.

Internal and External
 

gateway

Read a line of text from a file opened with uc4504.

Return code
< 0 = Error
>= 0 = Length Of Line Read

Internal and External

uc4504
 

gateway

Randomly read blocks from a file opened with
uc4506. Data is always read on a block boundary.

Return code
< 0 = Error
> 0 = Number of bytes actually read

Internal and External

uc4506
 

gateway

Read the next record from a file opened using uc4507.

Internal and External

uc4507
 

gateway

Read the next directory entry and save the entry's
information in memory. This information may then be accessed by the
routines uc4600 through uc4609.

Return code
< 0 = Error
0 = Entry Read
1 = End Of Subdirectory
2 = End Of Directory

Internal and External

uc4508
 

gateway

Returns the full filespec of the last directory entry
read. This is provided so the Open C API program need not be
concerned with the syntax of filespecs in forming them.

Internal and External

uc4508
 

gateway

Write characters to a file opened with uc4500.
The count will be rounded up to the next integer
boundary (e.g. a write of 5 will actually write 8 characters).

Internal and External

uc4500
 

gateway

Write integers to a file opened with uc4500.

Internal and External

uc4500
 

gateway

Write reals to a file opened with uc4500.

Internal and External
 

gateway

Write bytes to a file opened with uc4500.

Internal and External

uc4500
 

gateway

Write a line to a text file. Only complete lines may
be written to a text file. The addition of any delimiters (e.g. newline)
is done automatically.

Internal and External

uc4504
 

gateway

uc4525 is used to write a page break to a text file.

Internal and External

uc4504
 

gateway

Randomly write to a file opened with uc4506. The
data is always written on a block boundary.

Internal and External

uc4506
 

gateway

Write a record to a file opened with uc4507. For fixed
length record files, the parameter bytes is ignored.

Internal and External

uc4507
 

gateway

Skip characters in a file opened with uc4500.
Skips may be backward by using negative skip counts.

Internal and External

uc4500
 

gateway

Skip integers in a file opened with uc4500.
Skips may be backward by using negative skip counts.

Internal and External
 

gateway

Skip reals in a file opened with uc4500.
Skips may be backward by using negative skip counts.

Internal and External
 

gateway

Skip bytes in a file opened with uc4500.
Skips may be backward by using negative skip counts.

Internal and External
 

gateway

Find the current position within a file opened with
uc4500. That position may then be restored using uc4535.

Return code:
< 0 = Error
>= 0 = File position

Internal and External

uc4500
uc4535
 

gateway

Restore the read/write position within a file
previously saved using uc4534. The file must have been opened with
uc4500.

Internal and External

uc4500
uc4534
 

gateway

Reposition a file back to the beginning. This may be
used for binary, text, and record I/O files.

Internal and External
 

gateway

Close a file opened with either uc4500, uc4504,
uc4506, or uc4507. The close disposition is used to indicate whether a
file opened for write is to be saved or not. A normal close will make
the file permanent and delete any previous file with the same name.
An abort close will delete the file and retain any previous file with the
same name.

Internal and External
 

gateway

Determine characteristics of an open file given its I/O channel number.
The integer date/times in qreslt (if qreslt = 6) can be converted to
character strings using uc4582.

Starting in NX 11 a query type of 5 is no longer supported.

Internal and External

For description of file types see table
 

gateway

Determines the file length (in bytes) of
an open file given its I/O channel number.

Internal and External
 

gateway

Close any directories opened with uc4508. If any
subdirectories are open, they will be closed as well.

Internal and External

uc4508
 

gateway

Close a subdirectory opened with uc4509. Directory
reads will then continue with the previous directory.

Internal and External

uc4509
 

gateway

Checks whether the specified file of the given type exists.

NOTE: Mixed or upper case file names may not be found if the
environment variable UGII_OPTION = LOWER is set.

Passing an ftype of 0 will look for a file but does not work for a directory.
To check for a directory the ftype must be set to 100.

Return code:
< 0 = Error
= 0 = File Exists
= 1 = File Does Not Exist

Internal and External

For description of file types see table
 

gateway

Remove a given file from the file system.

Internal and External

For description of file types see table
 

gateway

Change the name of a given file. The new file name
should be a simple name (e.g. no directory specification).

Internal and External

For description of file types see table
 

gateway

Create an empty directory.

Internal and External
 

gateway

Retrieve the header information of a single file and
store it in memory. The information may then be retrieved using
uc4600 through uc4609.

Internal and External

uc4600
uc4601
uc4602
uc4603
uc4605
uc4606
uc4607
uc4608
uc4609
For description of file types see table
 

gateway

Read the current default value for a directory.

Internal and External
 

gateway

Change the current user's directory.

Internal and External
 

gateway

Copies or moves a file from a source file specification to a destination file
specification. When any move option is used, the source file will only be
deleted after it has been successfully copied to the destination file.

Using a file type of -1 indicates "any file type" so changing extensions
during the copy or move operation will work correctly.

Internal and External

For description of file types see table
 

gateway

Examine a filespec and make sure it conforms to the syntax of the file
system.

Internal and External

For description of file types see table
 

gateway

Examine a filespec and make sure it is a valid directory specification for
the file system. A "directory file spec" is a path to a file which is a
directory.

Internal and External

For description of file types see table
 

gateway

Examine a filespec and make sure it is a valid wildcard directory specification
for the file system. This will also indicate whether there were any
wildcard characters in the filespec. To find all files that match the wildcard
filespec, open the directory with uc4508 and supply the wildcard filespec,
then read (uc4518) each matching entry and the corresponding filespec (uc4519).

Return code:
= 0 = Valid file specification
= 1 = Valid with wildcards
Anything else is an error

Internal and External

For description of file types see table
 

gateway

Given a filespec return its fully qualified equivalent. If
a non-zero file type is given, the extension will also be set. For
example, the native system with a default directory DISK2/JOE
fspec = "foo", type = 2 will produce expfspec = "DISK2/JOE/FOO.PRT"

Internal and External

For description of file types see table
 

gateway

Accept a filespec and removes any directory path, extension,
and any system specific information and returns the resultant simple
filename. For example:
fspec = "/DISK1/JOE/FOO.PRT", ftype = 2 will produce fname = "FOO".

Internal and External

For description of file types see table
 

gateway

Combine a directory with a filename producing a file specification (filespec).
For example:

dspec = "/manager", ftype = 2, fname = "bar"

will produce fspec = "/MANAGER/BAR.PRT".

If the file name is a directory, using a filetype of 100 will merge the
directories. For example:

dspec = "/manager", ftype = 100, fname = "bar"

will produce fspec = "/MANAGER/BAR".

Internal and External

For description of file types see table
 

gateway

Take a filespec and returns its directory and filename components. For example:

fspec = "/Manager/Work/BENCH", ftype = 2


Note that this routine is impacted by the UGII_OPTION environment variable,
so if UGII_OPTION=lower is set, then the above example will produce:
dspec = "/manager/work" and fname = "bench.prt".

Internal and External

For description of file types see table
 

gateway

The name returned is a unique name for a temporary file. The resultant
filename is unique from other processes at the time. From a single
process, filenames will begin duplicating after the first 1,679,615 calls
to uc4577. Temporary files should be deleted when no longer needed by an
application. If the files are not deleted, there is a chance that the same
name may come up again if the same user happens to get the same process id
on a later date.

The maximum number of characters which will be returned is 12.

Internal and External
 

gateway

Remove the file extension from a given file specification and
returns the resultant file specification.

Internal and External

For description of file types see table
 

gateway

Form the full filespec, given a simple name of a file
in the UGII_UTIL directory.

Internal and External

For description of file types see table
 

gateway

return the four character symbolic name for a given ftype
code (e.g.: 'PART' for ftype code 2). Many ftype codes will return
'TEXT' which indicates the file's contents may be displayed as ascii
data. Unnamed ftypes will have their numeric code returned in ascii.

Return code:
< 0 = Error
= 0 = Format Returned
= 1 = Format Undefined

Internal and External

For description of file types see table
 

gateway

Convert the symbolic character representation of a file type
into its numeric equivalent. For example, "PART" translates to a 2.

Return code:
= 0 = Unknown Symbolic Name
> 0 = File Type

Internal and External
 

gateway

Convert NX computational time to display form. Two forms are available
for the date and two forms are available for the time.
A date or time of -1 returns the current date and/or time.

NOTE: In option 9 of the dtype argument, "formatted for the locale"
means that the date and time string is appropriate for the language in
which the user's operating system environment runs under.

Return code:
0 = No error
not 0 = Error code

Internal and External

uc4583

The dtype argument was modified in V13.0 to
increase the number of options from 4 to 9.
 

gateway

Convert a character date and time to NX computational date and time.

Return Code:
0 = Success
1 = Failure

Internal and External

uc4582
 

gateway

Query the user name, String Result

Internal and External
 

gateway

Query a set of characteristics. The result for each item code follows:
Login Status: (qitem = 1)
bit 0 = Login Status
0 = NOT LOGGED IN
1 = LOGGED IN
bit 1 = Username Status
0 = DO NOT NEED A USERNAME TO LOGIN
1 = USERNAME NEEDED FOR LOGIN
bit 2 = Password Status
0 = DO NOT NEED A PASSWORD TO LOGIN
1 = PASSWORD NEEDED FOR LOGIN
bits 3-15 = Reserved
File Header Support: (qitem = 2)
bit 0 = Owner Supported
0 = NO
1 = YES
bit 1 = Protection Classes Supported
0 = NO
1 = YES
bit 2 = Status Word Supported
0 = NO
1 = YES
bit 3-4 = Reserved
bit 5 = Description Supported
0 = NO
1 = YES
bit 6 = Customer Area Supported
0 = NO
1 = YES
bit 7 = Non-Native Files Supported
0 = NO
1 = YES
bits 8-15 = Reserved

Internal and External
 

gateway

Translate an error code to the text associated with it.
Due to the way error handling is done in the file system routines, the
error text should be retrieved before another error occurs otherwise
the error message might be lost.

Internal and External
 

gateway

Return the simple file name of the last file read with uc4518 or uc4564..
To obtain the full file specification, including the directory use uc4519.

Internal and External

uc4518
uc4564
uc4519
 

gateway

Return the file type of the last file read with uc4518 or uc4564..
You may use uc4581 to translate the file type to a character string.

Return code:
< 0 = error
>= 0 = file type

Internal and External

uc4518
uc4564
uc4581
 

gateway

Return the status word of the last file read with uc4518 or uc4564..

Internal and External

uc4518
uc4564
 

gateway

Return the owner of the last file read with uc4518 or uc4564..

Internal and External

uc4518
uc4564
 

gateway

Return the length of the last file read with uc4518 or uc4564..

Return code:
>= 0 = File Length In Bytes
< 0 = error code

Internal and External

uc4518
uc4564
 

gateway

Return the creation, modification, and last access date/time
of the last file read with uc4518 or uc4564..
Use uc4582 to convert the date/time to character strings.

Internal and External

uc4518
uc4564
uc4582
 

gateway

Return the descriptions area of the last file read with uc4518 or uc4564..

Internal and External

uc4518
uc4564
 

gateway

Return the customer area of the last file read with uc4518 or uc4564..

Internal and External

uc4518
uc4564
 

gateway

Return the machine field of the last file read with uc4518 or uc4564.
These values are available for part files only. Parts filed in
V10.0 or earlier return unknown values.

Return code:
< 0 = error
1 = APOLLO
2 = DEC VAX/VMS
3 = HP CISC
4 = HP RISC
5 = SUN 3
6 = SUN SPARC
7 = DEC RISC (ULTRIX)
8 = SGI
9 = DATA GENERAL
10 = IBM MVS
11 = IBM AIX
12 = AXP/OSF
13 = AXP/VMS

Internal and External

uc4518
uc4564
 

gateway

Modify the status header field of a file. An error returns if the file
system does not support a status field or the user does not have the privilege
to change it.

Internal and External

For description of file types see table
 

gateway

Modify the owner header field of a file. An error returns if the file system
does not support an owner field or the user does not have the privilege to
change it (some operating systems may require root privilege to change file
ownership).

Internal and External

For description of file types see table
 

gateway

Change the description header field of a file. An
error is returned if the file system does not support a description field or
the user does not have the privilege to change it.

Internal and External

For description of file types see table
 

gateway

Change the customer area header field of a file. An
error will be returned if the file system does not support a customer
area field or the user does not have the privilege to change it.
This function modifies the part file on disk and should not
be used on a part file that has already been opened in NX. If this
occurs, the part cannot be saved. Use UF_PART_set_customer_area to
modify the customer area of a loaded part.

Internal and External

UF_PART_set_customer_area
For description of file types see table
 

gateway

Read a switch from the program command line given the name of the switch.
All switches are global switches; they may appear anywhere on the command line.
Switches may have a value or no value. For example:
/LIST=FOO.LIS switch with a value
/LIST switch with no value

The characters that must match should be specified using upper case characters.
The user entered switch must completely match, but matching is case insensitive.
So if the program passes:
"PARTfile"
as the switch, then the following user entries will match:
-part=abc
-partfi=abc
-partfile=abc
-PARTFILE=abc
And the following user entries will not match:
-p=abc // Not enough characters
-parti=abc // the i does not match the specified f

Under UNIX, switches take the form:
-name no value
-name=value switch with a value

Switches are separated by blanks on UNIX. For example:
ugraf -user=manager -pass=frogs

Under WNT, switches take the form:
-name no value
-name:value switch with a value
-name=value switch with a value

NOTE: Use uc4624 in conjunction with this function. You must call
uc4624 before calling either uc4620 or uc4621.

Return code:
< 0 = Error
0 = Switch Not Present
1 = Switch Found With No Value
3 = Switch Found With A Value

External

uc4624
uc4621
 

gateway

Read arguments from the command line. Each argument may be read only once.
NOTE: Use uc4624 in conjunction with this function. You must call
uc4624 before calling either uc4620 or uc4621.

Return code:
< 0 = Error
0 = Argument Not Present
1 = Argument Found

External

uc4624
uc4620
 

gateway

Returns an argument list to the GRIP xspawn command. The returned string
can not exceed 132 characters.

Internal and External
 

gateway

Returns a pointer to a string which is the release number of the
specified part file. Some of the possible values are shown for the
description of cr2. You must allocate sufficient size for the relnum
array. For example, you could use MAX_FSPEC_BUFSIZE (prototyped in
uf_defs.h) for the size of the array.

Internal and External
 

gateway

Save argument names for use with uc4620 and uc4621. The prog
parameter is not used. It is only present for backward compatibility.
You must use uc4624 before calling uc4620 or uc4621.

Note that uc4624 expects to receive the argc and argv values passed to the
program from main, and so the values in argv are assumed to be in the current
users locale not UTF8 data. As such this routine does not honor the setting of the text
mode made by calling UF_TEXT_set_text_mode().

External

uc4620
uc4621
 

gateway

Outputs a sorted directory listing to the Information Window if it has
been opened. Use UF_UI_open_listing_window to open the
Information Window. Dates in cbuf must be in the format
DD-MMM-YY (eg. 04-JUL-89).

Return code:
< 0 = Error code
0 = No files listed
> 0 = Number of files listed

UF_UI_open_listing_window
 

gateway

Return the language name stored in the native binary file.
You can use the returned language name string
to differentiate languages that use the same character set.
NOTE: If a Native Binary File has not been loaded then uc4901
returns "ENGLISH".

Return code
0 = No error
not 0 = Error code

Internal and External
 

gateway

Test if a file exists.

Note: This function only works with files - not directories. To check if a
directory exists use uc4560 and pass a file type of 100.

0 - No error
Otherwise - Error Code

Internal and External

Originally released in V16.0
 

gateway

Spawn a subprocess. The return code will indicated the status of the
process creation. If the status from the actual command is needed, use
UF_CFI_spawn_check_status.

Internal and External

UF_CFI_spawn_check_status

Originally released in V18.0
 

gateway

Check the status of a spawned subprocess.

Internal and External

UF_CFI_spawn

Originally released in V18.0
 

gateway