https://wiki.vmssoftware.com/api.php?action=feedcontributions&feedformat=atom&user=Brett.cameronVSI OpenVMS Wiki - User contributions [en]2026-06-02T12:42:31ZUser contributionsMediaWiki 1.43.3https://wiki.vmssoftware.com/index.php?title=VMS-Specific_Python_Modules&diff=2514VMS-Specific Python Modules2022-07-06T23:26:34Z<p>Brett.cameron: /* RMS */</p>
<hr />
<div>== vms.decc ==<br />
<br>Wraps the '''C Run-Time Library for OpenVMS Systems''' functions.<br><br />
----<br />
=== dlopen_test(name:str)->int ===<br />
Checks if a shared image can be opened and loaded into memory.<br />
;parameters<br />
: <code>name:str</code>: path to the shared image<br />
;returns<br />
: <code>1</code>: if the shared image exists and can be opened by dlopen()<br />
: <code>0</code>: otherwise<br />
----<br />
=== fix_time(vms_time:int)->int ===<br />
Converts the VMS time to the Unix time stamp.<br />
;parameters<br />
: <code>vms_time:int</code>: VMS system time<br />
;returns<br />
:Time in the Unix format (number of seconds since 01/01/1970)<br />
----<br />
=== from_vms(vms_path:str, wild_flag:int)->list ===<br />
Converts the VMS path to a list of Unix paths.<br />
;parameters<br />
: <code>vms_path:str</code>: path in the VMS format (supports wildcards)<br />
: <code>wild_flag:int</code>: If set to <code>0</code>, the wildcards found in <code>vms_path</code> are not expanded <br />
;returns<br />
:List of paths in the Unix notation<br />
----<br />
=== getenv(name:str, def_value:str)->str ===<br />
Gets the specified environment variable value. See getenv() description in the '''VSI C Run-Time Library Reference Manual for OpenVMS Systems'''.<br />
;parameters<br />
: <code>name:str</code>: name of the environment variable<br />
: <code>def_value:str</code>: default value<br />
;returns<br />
:Environment variable value<br />
----<br />
=== sleep(seconds:int)->int ===<br />
Suspends execution of the current process or thread for the specified number of seconds.<br />
;parameters<br />
: <code>seconds:int</code>: seconds to sleep<br />
;returns<br />
:The number of seconds left before the sleep timer expires if sleep is interrupted. <code>0</code> if the process slept for the specified number of seconds<br />
----<br />
=== sysconf(name:int)->int ===<br />
Provides a method for determining the current value of a configurable system limit or whether optional features are supported.<br />
;parameters<br />
: <code>name:int</code>: system variable to be queried<br />
;returns<br />
:Requested value<br />
----<br />
=== to_vms(unix_path:str, allow_wild:int, no_directory:int)->list ===<br />
Converts the UNIX style file specifications to the OpenVMS file specifications.<br />
;parameters<br />
: <code>unix_path:str</code>: file name following the Unix file naming conventions<br />
: <code>allow_wild:int</code>: If set to <code>0</code>, the wildcards found in <code>unix_path</code> are not expanded<br />
: <code>no_directory:int</code> An integer that has one of the following values:<br />
:* 0 - Directory allowed<br />
:* 1 - Prevent expansion of the string as a directory name<br />
:* 2 - Force expansion of the string as a directory name<br />
;returns<br />
List of OpenVMS style pathnames<br />
----<br />
=== unixtime(vms_time:int)->int ===<br />
Converts the OpenVMS system time to the Unix local time.<br />
;parameters<br />
: <code>vms_time:int</code> OpenVMS system time<br />
;returns<br />
:Unix time<br />
----<br />
=== vmstime(unix_time:int)->int ===<br />
Converts Unix time to the OpenVMS system time.<br />
;parameters<br />
: <code>unix_time:int</code>: Unix time<br />
;returns<br />
OpenVMS system time<br />
----<br />
=== get_symbol(name:str)->list ===<br />
Requests the calling process’s command language interpreter (CLI) to return the value of a CLI symbol as a string.<br />
;parameters<br />
: <code>name:str</code>: Name of the symbol<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>str</code>: value of the returned symbol<br />
----<br />
=== fopen(path:str, mode:str, ...)->fp:object ===<br />
Opens a file.<br />
;parameters<br />
: <code>path:str</code>: A character string containing a valid file specification<br />
: <code>mode:str</code>: The access mode indicator<br />
: <code>...:str</code>: Optional file attribute arguments<br />
;returns<br />
:*<code>fp:object</code>: File pointer<br />
----<br />
=== fclose(fp:object)->status:int ===<br />
Closes a file.<br />
;parameters<br />
: <code>fp:object</code>: A pointer to the file to be closed<br />
;returns<br />
:*<code>status:int</code>: status code of the operation<br />
----<br />
=== fileno(fp:object)->fd:int ===<br />
Returns the file descriptor associated with the specified file pointer.<br />
;parameters<br />
: <code>fp:object</code>: A pointer to the file<br />
;returns<br />
:*<code>fd:int</code>: Integer file descriptor<br />
----<br />
=== write(fd:int, data:bytes)->nbytes:int ===<br />
Writes bytes to a file.<br />
;parameters<br />
: <code>fd:int</code>: Integer file descriptor<br />
: <code>data:bytes</code>: Bytes to write<br />
;returns<br />
:*<code>nbytes:int</code>: The number of bytes written<br />
----<br />
<br />
=== fgets(fp:object, maxchars:int)->line:str ===<br />
Reads a line from the specified file, up to one less than the specified maximum<br />
number of characters or up to and including the newline character, whichever<br />
comes first.<br />
;parameters<br />
: <code>fp:object</code>: A pointer to the file<br />
: <code>maxchars:int</code>: The maximum number of characters to fetch<br />
;returns<br />
:*<code>line:str</code>: The fetched line<br />
----<br />
<br />
=== feof(fp:object)->status:int ===<br />
Tests a file to see if the end-of-file has been reached.<br />
;parameters<br />
: <code>fp:object</code>: A pointer to the file<br />
;returns<br />
:*<code>status:int</code>: Nonzero integer indicates that the end-of-file has been reached<br />
----<br />
=== ferror(fp:object)->status:int ===<br />
Returns a nonzero integer if an error occurred while reading or writing a file.<br />
;parameters<br />
: <code>fp:object</code>: A pointer to the file<br />
;returns<br />
:*<code>status:int</code>: Nonzero integer indicates that an error has occurred<br />
----<br />
<br />
== vms.ile3 ==<br />
<br>Provides functions to work with item lists.<br><br />
----<br />
=== new()->object ===<br />
Creates an empty item list.<br />
;parameters<br />
: <code>None</code><br />
;returns<br />
:New empty item list<br />
----<br />
=== delete(il:object)->None ===<br />
Deletes the item list.<br />
;parameters<br />
: <code>il:object</code>: item list to be removed<br />
;returns<br />
: <code>None</code><br />
----<br />
=== size(il:object)->int ===<br />
Gets the size of the item list.<br />
;parameters<br />
: <code>il:object</code>: item list<br />
;returns<br />
:The size of the specified item list<br />
----<br />
=== addint(il:object, item:int, item_type:int, item_value:int)->None ===<br />
Adds a new integer to the item list.<br />
;parameters<br />
: <code>il:object</code>: item list<br />
: <code>item:int</code>: item to add<br />
: <code>item_type:int</code>: type of the item. See '''vms.dscdef'''<br />
: <code>item_value:int</code>: value of the item<br />
;returns<br />
: <code>None</code><br />
----<br />
=== getint(il:object, index:int)->int ===<br />
Gets the integer at the specified index in the item list.<br />
;parameters<br />
: <code>il:object</code>: item list<br />
: <code>index:int</code>: index of the item to get<br />
;returns<br />
:Integer value<br />
----<br />
=== gethex(il:object, index:int)->str ===<br />
Gets the integer at the specified index in the item list and returns it as a hexadecimal string.<br />
;parameters<br />
: <code>il:object</code>: item list<br />
: <code>index:int</code>: index of the item to get<br />
;returns<br />
:Hexadecimal string<br />
----<br />
=== addstr(il:object, item:int, item_value:str, item_length:int)->None ===<br />
Adds the specified string to the item list. If <code>item_value</code> is not <code>None</code>, <code>item_length</code> is ignored and the length of the buffer will be the same as the length of <code>item_value</code>.<br />
;parameters<br />
: <code>il:object</code>: item list<br />
: <code>item:int</code>: item to add<br />
: <code>item_value:str</code>: value to add (or <code>None</code>)<br />
: <code>item_length:int</code>: length of the buffer if <code>item_value</code> is <code>None</code><br />
;returns<br />
: <code>None</code><br />
----<br />
=== addstrd(il:object, item:int, item_value:str, item_length:int)->None ===<br />
Adds the specified space-expanded string to the item list. The first byte of the buffer is the length of the string. If <code>item_value</code> is longer than <code>item_length</code>, it will be truncated.<br />
;parameters<br />
: <code>il:object</code>: item list<br />
: <code>item:int</code>: item to add<br />
: <code>item_value:str</code>: value to add<br />
: <code>item_length:int</code>: length of the buffer (the resulting string length is one byte less)<br />
;returns<br />
: <code>None</code><br />
----<br />
=== addstrn(il:object, item:int, item_value:str, item_length:int)->None ===<br />
Adds the specified space-expanded string to the item list. If <code>item_value</code> is longer than <code>item_length</code>, it will be truncated.<br />
;parameters<br />
: <code>il:object</code>: item list<br />
: <code>item:int</code>: item to add<br />
: <code>item_value:str</code>: value to add<br />
: <code>item_length:int</code>: length of the buffer<br />
;returns<br />
: <code>None</code><br />
----<br />
=== getstr(il:object, index:int, flag:int)->str ===<br />
Gets the string at the specified index in the item list.<br />
;parameters<br />
: <code>il:object</code>: item list<br />
: <code>index:int</code>: index of the item to get<br />
: <code>flag:int</code>: if set to <code>1</code>, the first byte of the resulting string is the length of the string<br />
;returns<br />
:String<br />
----<br />
=== addbin(il:object, item:int, item_value:int, item_offset:int, item_len:int)->None ===<br />
Adds a new binary item to the item list. This item will be interpreted as a string.<br />
;parameters<br />
: <code>il:object</code>: item list<br />
: <code>item:int</code>: item to add<br />
: <code>item_value:int</code>: value to store<br />
: <code>item_offset:int</code>: starting byte<br />
: <code>item_len:int</code>: amount of bytes<br />
;returns<br />
:<code>None</code><br />
----<br />
=== getbyte(il:object, index:int, item_offset:int)->int ===<br />
Gets the byte at the specified position in the item list.<br />
;parameters<br />
: <code>il:object</code>: item list<br />
: <code>index:int</code>: index of the item<br />
: <code>item_offset:int</code>: starting byte<br />
;returns<br />
:Integer value of the specified byte<br />
----<br />
<br />
== vms.lib ==<br />
<br>Wraps the '''OpenVMS RTL Library (LIB$)''' functions.<br><br />
----<br />
=== create_dir(name:str, uic:int, pe:int, pv:int)->int ===<br />
Creates a directory.<br />
;parameters<br />
: <code>name:str</code>: name of the directory to be created (following the OpenVMS naming conventions)<br />
: <code>uic:int</code>: unsigned integer value of the owner UIC: <br />
:*<code>None</code>: current user<br />
:*<code>0</code>: owner of the parent directory<br />
: <code>pe:int</code>: protection-enable. Refer to the '''VSI OpenVMS RTL Library (LIB$) Manual''' for more info about LIB$CREATE_DIR.<br />
: <code>pv:int</code>: protection-value<br />
;returns<br />
: <code>vms.ssdef.SS__CREATED</code>: one or more directories created<br />
: <code>vms.ssdef.SS__NORMAL</code>: all the specified directories already exist<br />
: Some other error. See in '''vms.ssdef'''<br />
----<br />
=== date_time()->list ===<br />
Gets current date and time.<br />
;parameters<br />
: <code>None</code><br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>str</code>: resulting string<br />
----<br />
=== get_ef()->list ===<br />
Allocates the local event flag.<br />
;parameters<br />
:<code>None</code><br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code>: resulting event flag<br />
----<br />
=== free_ef(ef:int)->int ===<br />
Releases the local event flag. <br />
;parameters<br />
: <code>ef:int</code>: local event flag<br />
;returns<br />
:Status code of the operation<br />
----<br />
=== put_common(common:str)->int ===<br />
Copies a string into the common area. <br />
;parameters<br />
: <code>common:str</code>: string to copy<br />
;returns<br />
:Status code of the operation<br />
----<br />
=== get_common()->list ===<br />
Gets the string from the common area.<br />
;parameters<br />
: <code>None</code><br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>str</code>: resulting string<br />
----<br />
=== get_hostname(flags:int)->list ===<br />
Gets the host name of the local system.<br />
;parameters<br />
: <code>flags:int</code> if set to <code>1</code>, the host node name is returned in a parseable format<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>str</code>: resulting host node name<br />
----<br />
=== getjpi(item_code:int, pid:int, pname:str)->list ===<br />
Gets the specified job/process information as a string.<br />
;parameters<br />
: <code>item_code:int</code>: item identifier code defining the item of the information to be returned. See '''vms.jpidef'''<br />
: <code>pid:int</code>: process ID<br />
: <code>pname:str</code>: process name<br />
For valid combination of the values of <code>pid</code> and <code>pname</code>, see the '''OpenVMS RTL Library (LIB$) Manual''' for LIB$GETJPI. The resulting <code>pid</code> is not returned.<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>str</code>: resulting string<br />
----<br />
=== getsyi(item_code:int, node_name:str)->list ===<br />
Gets system-wide information as a string.<br />
;parameters<br />
: <code>item_code:int</code>: item identifier code defining the item of the information to be returned. See '''vms.syidef'''<br />
: <code>node_name:str</code>: node name<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>str</code>: resulting string<br />
:*<code>int</code>: resulting cluster system ID<br />
----<br />
=== spawn(command:str, input_file:str, output_file:str, flags:int, pname:str)->list ===<br />
Requests the command language interpreter (CLI) of the calling process to spawn a subprocess for executing CLI commands.<br />
;parameters<br />
: <code>command:str</code>: command to execute<br />
: <code>input_file:str</code>: equivalence name to be associated with the logical name SYS$INPUT<br />
: <code>output_file:str</code>: equivalence name to be associated with the logical name SYS$OUTPUT<br />
: <code>flags:int</code>: flag bits that designate optional behavior. See '''vms.clidef'''<br />
: <code>pname:str</code>: name defined for the subprocess<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code>: process ID of the spawned process<br />
----<br />
=== do_command(command:str)->None ===<br />
Stops program execution and directs the command language interpreter (CLI) to execute a command that is supplied as the argument.<br />
;parameters<br />
: <code>command:str</code>: command to execute<br />
;returns<br />
:If successful, it does not return control to the calling program.<br />
----<br />
<br />
== vms.sys ==<br />
<br>Wraps the '''OpenVMS System Services''' functions.<br><br />
----<br />
=== asctim(vms_time:int, time_only:int)->list ===<br />
Converts an absolute or delta time from 64-bit system time format to an ASCII string.<br />
;parameters<br />
: <code>vms_time:int</code>: OpenVMS system time. A negative time value represents a delta time.<br />
: <code>time_only:int</code>: if set to <code>1</code>, asctim returns the hour only.<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>str</code>: resulting string<br />
----<br />
=== bintim(time_str:str)->list ===<br />
Converts an ASCII string to an absolute or delta time value in the system 64-bit time format.<br />
;parameters<br />
: <code>time_str:str</code> in the following format:<br />
:*Absolute Time: dd-mmm-yyyy hh:mm:ss.cc<br />
:*Delta Time: dddd hh:mm:ss.cc<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code>: resulting time value<br />
----<br />
=== asctoid(name:str)->list ===<br />
Translates the specified identifier name into its binary identifier value.<br />
;parameters<br />
: <code>name:str</code>: identifier name<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code>: resulting identifier value<br />
:*<code>int</code>: resulting identifier attributes. See '''vms.kgbdef'''<br />
----<br />
=== idtoasc(id_val:int, context:int)->list ===<br />
Translates the specified identifier value to the identifier name.<br />
;parameters<br />
: <code>id_val:int</code>: identifier value. See '''OpenVMS System Services Reference Manual''' for SYS$IDTOASC<br />
: <code>context:int</code>: context value used when <code>idtoasc</code> is called repeatedly. Must be initialized with the value <code>0</code>.<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>str</code>: resulting identifier name<br />
:*<code>int</code>: resulting identifier value<br />
:*<code>int</code>: resulting identifier attributes. See '''vms.kgbdef'''<br />
:*<code>int</code>: resulting context<br />
----<br />
=== crembx(tmp:int, maxmsg:int, bufquo:int, promsk:int, acmode:int, mbx_name:string, flags:int)->list ===<br />
Creates a virtual mailbox device.<br />
;parameters<br />
: <code>tmp:int</code>: the first bit specifies a permanent mailbox <br />
: <code>maxmsg:int</code>: maximum size of a message (in bytes)<br />
: <code>bufquo:int</code>: number of bytes of system dynamic memory that can be used to buffer messages sent to the mailbox<br />
: <code>promsk:int</code>: protection mask to be associated with the created mailbox<br />
: <code>acmode:int</code>: access mode to be associated with the channel to which the mailbox is assigned<br />
: <code>mbx_name:string</code>: logical name to be assigned to the mailbox<br />
: <code>flags:int</code>: options for the assign operation. See '''vms.cmbdef'''<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code>: resulting channel<br />
----<br />
=== delmbx(channel:int)->int ===<br />
Marks a permanent mailbox for deletion.<br />
;parameters<br />
: <code>channel:int</code>: mailbox channel<br />
;returns<br />
:Status code<br />
----<br />
=== assign(devnam:str, acmode:int, mbxnam:str, flags:int)->list ===<br />
Provides a process with an I/O channel.<br />
;parameters<br />
: <code>devnam:str</code>: name of the device<br />
: <code>acmode:int</code>: access mode to be associated with the channel<br />
: <code>mbxnam:str</code>: logical name of the mailbox to be associated with the device<br />
: <code>flags:int</code>: an optional device-specific argument<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code>: resulting channel<br />
----<br />
=== dassgn(channel:int)->int ===<br />
Unassigns (releases) an I/O channel.<br />
;parameters<br />
: <code>channel:int</code>: number of the I/O channel to be unassigned<br />
;returns<br />
:Status code<br />
----<br />
=== readvblk(channel:int, max_read:int, block:int, fmod:int)->list ===<br />
Read from the I/O channel.<br />
;parameters<br />
: <code>channel:int</code>: I/O channel<br />
: <code>max_read:int</code>: amount of bytes to read<br />
: <code>block:int</code>: starting block<br />
: <code>fmod:int</code>: function code modifiers<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>byte</code>: resulting buffer<br />
:*<code>int</code>: I/O completion code<br />
----<br />
=== writevblk(channel:int, buffer:bytes, block:int, fmod:int)->list ===<br />
Write to the I/O channel.<br />
;parameters<br />
: <code>channel:int</code>: I/O channel<br />
: <code>buffer:bytes</code>: bytes to write<br />
: <code>block:int</code>: starting block<br />
: <code>fmod:int</code>: function code modifiers<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code>: amount of written bytes<br />
:*<code>int</code>: I/O completion code<br />
----<br />
=== cancel(channel:int)->int ===<br />
Cancel the I/O operation.<br />
;parameters<br />
: <code>channel:int</code>: I/O channel<br />
;returns<br />
:Status code<br />
----<br />
=== crelnm(attr:int, tabnam:str, lognam:str, acmode:int, il:object)->int ===<br />
Creates a logical name and specifies its equivalence names. <br />
;parameters<br />
: <code>attr:int</code>: attributes to be associated with the logical name. See '''vms.lnmdef'''<br />
: <code>tabnam:str</code>: name of the table in which to create the logical name<br />
: <code>lognam:str</code>: logical name to be created<br />
: <code>acmode:int</code>: access mode to be associated with the logical name. See '''vms.psldef'''<br />
: <code>il:object</code>: item list, created via [[VMS specific Python modules#new()->object|<code>vms.ile3.new()</code>]]<br />
See '''OpenVMS System Services Reference Manual''' for SYS$CRELNM.<br />
;returns<br />
:Status code<br />
----<br />
=== trnlnm(attr:int, tabnam:str, lognam:str, acmode:int, il:object)->int ===<br />
Returns information about the specified logical name.<br />
;parameters<br />
: <code>attr:int</code>: attributes controlling the search for the logical name. See '''vms.lnmdef'''<br />
: <code>tabnam:str</code>: name of the logical name table or the name of a searchlist logical name<br />
: <code>lognam:str</code>: logical name for which information is to be returned<br />
: <code>acmode:int</code>: access mode to be used in the translation. See '''vms.psldef'''<br />
: <code>il:object</code>: item list, created via [[VMS specific Python modules#new()->object|<code>vms.ile3.new()</code>]]<br />
See '''OpenVMS System Services Reference Manual''' for SYS$TRNLNM.<br />
;returns<br />
:Status code<br />
----<br />
=== dellnm(tabnam:str, lognam:str, acmode:int)->int ===<br />
Deletes all logical names with the specified name.<br />
;parameters<br />
: <code>tabnam:str</code>: name of a logical name table or the name of a searchlist logical name<br />
: <code>lognam:str</code>: logical name to be deleted<br />
: <code>acmode:int</code>: access mode to be used in the delete operation. See '''vms.psldef'''<br />
;returns<br />
:Status code<br />
----<br />
=== device_scan(search_devnam:str, item_list:object, context:int)->list ===<br />
Returns the names of all devices that match a specified set of search criteria.<br />
;parameters<br />
: <code>search_devnam:str</code>: name of the device for which <code>device_scan</code> to search<br />
: <code>item_list:object</code>: item list specifying search criteria<br />
: <code>context:int</code>: value used to indicate the current position of the search. On the initial call it must contain <code>0</code>.<br />
See '''OpenVMS System Services Reference Manual''' for SYS$DEVICE_SCAN<br />
;returns<br />
:The list:<br />
:* <code>int</code>: status code of the operation<br />
:* <code>str</code>: found device name<br />
:* <code>int</code>: context<br />
----<br />
=== uicstr(uic:int, flags:int)->list ===<br />
Converts UIC to a string.<br />
;parameters<br />
: <code>uic:int</code>: UIC<br />
: <code>flags:int</code> <br />
:*<code>0</code>: use "!%I" SYS$FAO format<br />
:*<code>1</code>: use "!%U" SYS$FAO format<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>str</code>: UIC string<br />
----<br />
=== getdvi(dev_nam:str, item_list:object)->int ===<br />
Returns information related to the primary and secondary device characteristics of an I/O device.<br />
;parameters<br />
: <code>dev_nam:str</code>: the name of the device for which information is to be returned<br />
: <code>item_list:object</code>: item list specifying which information about the device is to be returned<br />
See '''OpenVMS System Services Reference Manual''' for SYS$GETDVI<br />
;returns<br />
:Status code<br />
----<br />
=== getjpi(pid:int, pnam:str, item_list:object)->list ===<br />
Returns information about one or more processes of the system or across the OpenVMS Cluster system.<br />
;parameters<br />
: <code>pid:int</code>: process identification<br />
: <code>pnam:str</code>: name of the process<br />
: <code>item_list:object</code>: item list specifying which information about the process or processes is to be returned<br />
See '''OpenVMS System Services Reference Manual''' for SYS$GETJPI<br />
;returns<br />
:The list:<br />
:* <code>int</code>: status code of the operation<br />
:* <code>int</code>: process ID<br />
----<br />
=== getlki(lki:int, item_list:object)->list ===<br />
Returns information about the lock database on a system.<br />
;parameters<br />
: <code>lki:int</code>: identification of the lock (lock ID) information about which needs to be returned<br />
: <code>item_list:object</code>: item list specifying the lock information to be returned<br />
See '''OpenVMS System Services Reference Manual''' for SYS$GETLKI<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code>: lock identification<br />
----<br />
=== getmsg(msgid:int, flags:int)->list ===<br />
Returns message text associated with a given message identification code.<br />
;parameters<br />
: <code>msgid:int</code>: identification of the message to be retrieved<br />
: <code>flags:int</code>: message components to be returned<br />
See '''OpenVMS System Services Reference Manual''' for SYS$GETMSG<br />
;returns<br />
:The list:<br />
:* <code>int</code>: status code of the operation<br />
:* <code>str</code>: message string<br />
:* <code>int</code>: optional information<br />
----<br />
=== getqui(func:int, context:int, item_list:object)->list ===<br />
Returns information about queues and the jobs initiated from these queues.<br />
;parameters<br />
: <code>func:int</code>: function code specifying the function that <code>getqui</code> is to perform. See '''vms.quidef'''<br />
: <code>context:int</code>: context stream for this call<br />
: <code>item_list:object</code>: item list supplying the information to be used by the function <br />
See '''OpenVMS System Services Reference Manual''' for SYS$GETQUI<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code>: context<br />
----<br />
=== getrmi(item_list:object)->int ===<br />
Returns system performance information about the local system.<br />
;parameters<br />
: <code>item_list:object</code>: item list specifying which information about the local node is to be returned<br />
See '''OpenVMS System Services Reference Manual''' for SYS$GETRMI<br />
;returns<br />
:Status code<br />
----<br />
=== getsyi(csid:int, node_name:str, item_list:object)->list ===<br />
Returns information about the local system or about other systems in an OpenVMS Cluster system.<br />
;parameters<br />
: <code>csid:int</code>: OpenVMS Cluster system identification<br />
: <code>node_name:str</code>: name of the node about which information is to be returned<br />
: <code>item_list:object</code>: item list specifying which information about the node or nodes to return<br />
See '''OpenVMS System Services Reference Manual''' for SYS$GETSYI<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code>: CSID<br />
----<br />
=== gettim()->list ===<br />
Returns the current system time in a 64-bit format.<br />
;parameters<br />
:<code>None</code><br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code>: current system time<br />
----<br />
=== getuai(user_name:str, item_list:object)->int ===<br />
Returns authorization information about the specified user.<br />
;parameters<br />
: <code>user_name:str</code>: name of the user to get authorization information for<br />
: <code>item_list:object</code>: item list specifying which information to return<br />
See '''OpenVMS System Services Reference Manual''' for SYS$GETUAI<br />
;returns<br />
:Status code<br />
----<br />
=== hiber()->int ===<br />
Allows a process to make itself inactive but to remain known to the system so that it can be interrupted.<br />
;parameters<br />
:<code>None</code><br />
;returns<br />
:Status code<br />
----<br />
=== schdwk(pid:int, pname:str, time:int, reptim:int)->list ===<br />
Schedules the awakening (restart) of a process that has placed itself in the state of hibernation with the Hibernate service.<br />
;parameters<br />
: <code>pid:int</code>: process identification (PID) of the process to be awakened<br />
: <code>pname:str</code>: name of the process to be awakened<br />
: <code>time:int</code>: time at which the process is to be awakened<br />
: <code>reptim:int</code>: time interval at which the wakeup request is to be repeated<br />
See '''OpenVMS System Services Reference Manual''' for SYS$SCHDWK<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code>: PID<br />
----<br />
<br />
=== add_holder(id:int, holder:int, attrib:int)->int ===<br />
Adds the specified holder record to the target identifier.<br />
;parameters<br />
: <code>id:int</code>: target identifier granted to the specified holder<br />
: <code>holder:int</code>: holder identifier that is granted access to the target identifier<br />
: <code>attrib:int</code>: attributes to be placed in the holder record<br />
See '''OpenVMS System Services Reference Manual''' for SYS$ADD_HOLDER<br />
;returns<br />
:Status code<br />
----<br />
=== add_ident(name:str, id:int, attrib:int)->list ===<br />
Adds the specified identifier to the rights database.<br />
;parameters<br />
: <code>name:str</code>: identifier name to be added to the rights database<br />
: <code>id:int</code>: identifier to be created<br />
: <code>attrib:int</code>: attributes placed in the identifier’s record<br />
See '''OpenVMS System Services Reference Manual''' for SYS$ADD_IDENT<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code> <code>resid</code>: identifier value assigned by the system<br />
----<br />
=== find_held(holder:int, context:int)->list ===<br />
Returns the identifiers held by the specified holder.<br />
;parameters<br />
: <code>holder:int</code>: holder whose identifiers to be found<br />
: <code>context:int</code>: context value used when <code>find_held</code> is called repeatedly<br />
See '''OpenVMS System Services Reference Manual''' for SYS$FIND_HELD<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code> <code>id</code>: identifier value that was found<br />
:*<code>int</code> <code>attrib</code>: attributes associated with the holder returned in <code>id</code><br />
:*<code>int</code> <code>context</code><br />
----<br />
=== finish_rdb(context:int)->int ===<br />
Deallocates the record stream and clears the context value.<br />
;parameters<br />
: <code>context:int</code>: context value to be cleared<br />
;returns<br />
:Status code<br />
----<br />
=== forcex(pid:int, pname:str, code:int)->int ===<br />
Causes an Exit ($EXIT) service call to be issued on behalf of a specified process.<br />
;parameters<br />
: <code>pid:int</code>: process identification (PID) of the process to force exit<br />
: <code>pname:str</code>: process name of the process that is to force exit<br />
: <code>code:int</code>: completion code value to be used as the exit parameter<br />
;returns<br />
:Status code<br />
----<br />
=== rem_holder(id:int, holder:int)->int ===<br />
Deletes the specified holder record from the target identifier’s list of holders.<br />
;parameters<br />
: <code>id:int</code>: binary value of the target identifier<br />
: <code>holder:int</code>: identifier of the holder being deleted<br />
;returns<br />
:Status code<br />
----<br />
=== rem_ident(id:int)->int ===<br />
Removes the specified identifier record and all its holder records (if any) from the rights database. <br />
;parameters<br />
: <code>id:int</code>: binary value of the identifier deleted from rights database<br />
;returns<br />
:Status code<br />
----<br />
=== setuai(user_name:str, item_list:object)->int ===<br />
Modifies the user authorization file (UAF) record for the specified user.<br />
;parameters<br />
: <code>user_name:str</code>: name of the user whose UAF record is modified<br />
: <code>item_list:object</code>: item list specifying which information from the specified UAF record is to be modified<br />
See '''OpenVMS System Services Reference Manual''' for SYS$SETUAI<br />
;returns<br />
:Status code<br />
----<br />
=== show_intrusion(user_criteria:str, flags:int, context:int)->list ===<br />
Searches for and returns information about records in the intrusion database matching the caller specifications.<br />
;parameters<br />
: <code>user_criteria:str</code>: description of an intruder or suspect<br />
: <code>flags:int</code>: type of records in the intrusion database about which information is to be returned. NOTE: do not use ''vms.ciadef.CIA_M_ITEMLIST'', because <code>user_criteria</code> is a string<br />
: <code>context:int</code>: context information to keep between related calls<br />
See '''OpenVMS System Services Reference Manual''' for SYS$SETUAI<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>str</code> <code>intruder</code>: user specification of the matched intruder or suspect record in the intrusion database<br />
:*<code>int</code> <code>expires</code>: quadword time format indicating the time when the record will expire<br />
:*<code>int</code> <code>type</code>: the types of the matched record and the status of the suspect<br />
:*<code>int</code> <code>count</code>: number of login failures or break-in attempts<br />
----<br />
<br />
== rdb ==<br />
<br>Wraps the '''Oracle Rdb''' functions.<br />
----<br />
=== Attach(dbname:string)->int ===<br />
Attaches to the specified database. The string may specify the full path to the Rdb database in the OpenVMS format or (more commonly) a logical name pointing to the database.<br />
;parameters<br />
: <code>dbname:string</code>: path or logical name<br />
;returns<br />
:Status code:<br />
:* <code>0</code>: success<br />
:* <code>-1</code>: failed<br />
----<br />
=== CloseCursor(cursor:object)->int === <br />
Closes the specified cursor.<br />
;parameters<br />
: <code>cursor:object</code>: cursor<br />
;returns<br />
:Status code:<br />
:*<code>0</code>: success<br />
:*<code>-1</code>: failed<br />
----<br />
=== Commit()->int ===<br />
Commits the current database transaction.<br />
;parameters<br />
:<code>None</code><br />
;returns<br />
:Status code:<br />
:*<code>0</code>: success<br />
:*<code>-1</code>: failed<br />
----<br />
=== Data(cursor:object, idx:int)->str ===<br />
Given a cursor handle and column index (integer), returns the data value for the specified column for the last fetch operation.<br />
;parameters<br />
: <code>cursor:object</code>: cursor<br />
: <code>idx:int</code>: index<br />
;returns<br />
:Resulting string<br />
----<br />
=== DeclareCursor(name:str, statement:str)->object ===<br />
Declares a cursor. Inputs are the name for the cursor and the SQL statement. On success the function returns a cursor handle that can be used with <code>OpenCursor()</code>, <code>FetchCursor()</code>, and <code>CloseCursor()</code>.<br />
;parameters<br />
: <code>name:str</code>: name for the cursor<br />
: <code>statement:str</code>: SQL statement<br />
;returns<br />
:Resulting cursor<br />
----<br />
=== Detach()->int ===<br />
Disconnects from the database.<br />
;parameters<br />
<code>None</code><br />
;returns<br />
:Status code:<br />
:*<code>0</code>: success<br />
:*<code>-1</code>: failed<br />
----<br />
=== Error()->str ===<br />
Returns a description of the last error.<br />
;parameters<br />
: <code>None</code><br />
;returns<br />
:Resulting error string<br />
----<br />
=== Exec(sh:object)->int ===<br />
Executes a previously prepared SQL statement.<br />
;parameters<br />
: <code>sh:object</code>: prepared SQL statement<br />
;returns<br />
:Status code:<br />
:*<code>0</code>: success<br />
:*<code>-1</code>: failed<br />
----<br />
=== ExecI(st:str)->int ===<br />
Executes the supplied SQL statement immediately.<br><br />
'''Note: the last letter is a capital 'i'<br />
;parameters<br />
: <code>st:str</code>: SQL statement<br />
;returns<br />
:Status code:<br />
:*<code>0</code>: success<br />
:*<code>-1</code>: failed<br />
----<br />
=== Fetch(cursor:object)->int ===<br />
Fetches a row of data for the specified cursor but does not explicitly return the fetched data. The <code>Data()</code> method can then be used to retrieve individual data values for each column (<code>Ncol()</code> can be used to determine the number of columns).<br />
;parameters<br />
: <code>cursor:object</code>: cursor<br />
;returns<br />
:Status code:<br />
:*<code>1</code>: success<br />
:*<code>0</code>: success, end of stream<br />
:*<code>-1</code>: failed<br />
----<br />
=== FetchRow(cursor:object)->list ===<br />
Fetches a row of data using the specified cursor handle. The fetched data is returned as a list of strings.<br />
;parameters<br />
: <code>cursor:object</code>: cursor<br />
;returns<br />
:The list of strings<br />
----<br />
=== Free(cursor:object)->int ===<br />
Frees resources associated with the supplied cursor handle for a cursor previously declared via <code>DeclareCursor()</code>.<br />
;parameters<br />
: <code>cursor:object</code>: cursor<br />
;returns<br />
:Status code:<br />
:*<code>0</code>: success<br />
----<br />
=== Ncol(cursor:object)->int ===<br />
Returns the number of columns (values) that would be returned by a fetch for the specified cursor.<br />
;parameters<br />
: <code>cursor:object</code>: cursor<br />
;returns<br />
:Number of columns<br />
----<br />
=== OpenCursor(cursor:object)->int ===<br />
Opens a cursor using the supplied (previously declared) cursor handle.<br />
;parameters<br />
: <code>cursor:object</code>: cursor<br />
;returns<br />
:Status code:<br />
:*<code>0</code>: success<br />
:*<code>-1</code>: failed<br />
----<br />
=== Prepare(st:string)->object ===<br />
Prepares an SQL statement and returns a handle for the prepared statement that can be used in subsequent calls to Exec().<br />
;parameters<br />
: <code>st:string</code>: SQL statement<br />
;returns<br />
:Resulting prepared statement<br />
----<br />
=== Rollback()->int ===<br />
Rolls back the current database transaction.<br />
;parameters<br />
:<code>None</code><br />
;returns<br />
:Status code:<br />
:*<code>0</code>: success<br />
:*<code>-1</code>: failed<br />
----<br />
=== SetReadonly()->int ===<br />
Starts a read-only transaction.<br />
;parameters<br />
:<code>None</code><br />
;returns<br />
:Status code:<br />
:*<code>0</code>: success<br />
:*<code>-1</code>: failed<br />
----<br />
=== Sqlcode()->int ===<br />
Returns the SQLCODE for the last database operation.<br />
;parameters<br />
:<code>None</code><br />
;returns<br />
:Resulting SQL code<br />
----<br />
<br />
== RMS ==<br />
<br>Working with RMS.<br> <br />
<br />
It should be noted that the RMS module is intended for use with indexed RMS files only.<br />
<br />
----<br />
=== BCD2String(bcd:bytes, prec:int)->str ===<br />
Converts BCD to string.<br />
;parameters<br />
: <code>bcd:bytes</code>: BCD<br />
: <code>prec:int</code>: precision<br />
;returns<br />
: <code>str</code>: BCD number as a string<br />
----<br />
<br />
=== String2BCD(repr:str, l:int, prec:int)->bytes ===<br />
Converts string to BCD.<br />
;parameters<br />
: <code>repr:str</code>: string representation of the BCD number<br />
: <code>l:int</code>: length<br />
: <code>prec:int</code>: precision<br />
;returns<br />
: <code>bytes</code>: BCD from string<br />
----<br />
<br />
=== BCD2Tuple(bcd:bytes, prec:int)->tuple ===<br />
Converts BCD to tuple: (sign, (digits,), precision).<br />
;parameters<br />
: <code>bcd:bytes</code>: BCD<br />
: <code>prec:int</code>: precision<br />
;returns<br />
: <code>tuple</code>: BCD parsed to a tuple<br />
----<br />
<br />
=== Tuple2BCD(repr:tuple, l:int, prec:int)->bytes ===<br />
Converts tuple to BCD.<br />
;parameters<br />
: <code>repr:tuple</code>: tuple representation of the BCD number<br />
: <code>l:int</code>: length<br />
: <code>prec:int</code>: precision<br />
;returns<br />
: <code>bytes</code>: BCD from tuple<br />
----<br />
<br />
=== getrmsattr(path:str, attr:int)->int ===<br />
Gets an RMS attribute.<br />
;parameters<br />
: <code>path:str</code>: VMS path to the file<br />
: <code>attr:int</code>: attribute to retrieve<br />
;returns<br />
: <code>attr:int</code>: attribute value<br />
----<br />
<br />
=== parse(path:str)->tuple ===<br />
Parses the VMS path to a tuple of bytes: (node, disk, directory, name, extension, version)<br />
;parameters<br />
: <code>path:str</code>: VMS path to the file<br />
;returns<br />
: <code>tuple</code>: parsed path<br />
----<br />
<br />
=== file(name:str, fac:int, shr:int, fop:int)->rmsFile ===<br />
Opens a file<br />
;parameters<br />
: <code>path:str</code>: VMS path to the file<br />
: <code>fac:int</code>: file access<br />
: <code>shr:int</code>: sharing options<br />
: <code>fop:int</code>: file processing options<br />
;returns<br />
: <code>file:rmsFile</code>: rmsFile object<br />
----<br />
<br />
=== RMS file object ===<br />
<br />
==== Members ====<br />
===== longname =====<br />
Full path to the file<br />
===== nok =====<br />
Number of keys<br />
===== org =====<br />
File organization<br />
----<br />
==== Methods ====<br />
===== close =====<br />
close() -> status<br><br />
Closes file.<br />
----<br />
===== delete =====<br />
delete([key]) -> status<br><br />
Deletes the current record or the first record with the given key.<br />
----<br />
===== fetch =====<br />
fetch([key]) -> status, record<br><br />
Retrieves the record from a file.<br />
----<br />
===== find =====<br />
find([key]) -> status<br><br />
Locates the specified record and establishes it as the current record.<br />
----<br />
===== flush =====<br />
flush() -> status<br><br />
Writes out all modified I/O buffers and file attributes associated with the file.<br />
----<br />
===== free =====<br />
free() -> status<br><br />
Unlocks all records that were previously locked for the record stream.<br />
----<br />
===== put =====<br />
put(record) -> status<br><br />
Inserts a record into a file.<br />
----<br />
===== release =====<br />
release() -> status<br><br />
Unlocks the record.<br />
----<br />
===== rewind =====<br />
rewind([keynum]) -> status<br><br />
Sets the context of a record stream to the first record in the file.<br />
----<br />
===== update =====<br />
update(record) -> status<br><br />
Allows to modify the contents of an existing record in a file residing on a disk device.<br />
----<br />
===== usekey =====<br />
usekey([keynum]) -> status<br><br />
Specifies the key or index to which the operation applies.<br />
----<br />
===== setrop =====<br />
setrop(rop) -> status<br><br />
Specifies which of the various optional record operations are to be implemented for the program.<br />
----<br />
<br />
=See also=<br />
* {{Template:CRuntime}}<br />
* {{Template:RTLLibrary}}<br />
* {{Template:SyservI}}<br />
* {{Template:SyservII}}<br />
<br />
[[Category:VMS Python]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS-Specific_Python_Modules&diff=2503VMS-Specific Python Modules2022-06-07T21:53:19Z<p>Brett.cameron: </p>
<hr />
<div>== vms.decc ==<br />
<br>Wraps the '''C Run-Time Library for OpenVMS Systems''' functions.<br><br />
----<br />
=== dlopen_test(name:str)->int ===<br />
Checks if a shared image can be opened and loaded into memory.<br />
;parameters<br />
: <code>name:str</code>: path to the shared image<br />
;returns<br />
: <code>1</code>: if the shared image exists and can be opened by dlopen()<br />
: <code>0</code>: otherwise<br />
----<br />
=== fix_time(vms_time:int)->int ===<br />
Converts the VMS time to the Unix time stamp.<br />
;parameters<br />
: <code>vms_time:int</code>: VMS system time<br />
;returns<br />
:Time in the Unix format (number of seconds since 01/01/1970)<br />
----<br />
=== from_vms(vms_path:str, wild_flag:int)->list ===<br />
Converts the VMS path to a list of Unix paths.<br />
;parameters<br />
: <code>vms_path:str</code>: path in the VMS format (supports wildcards)<br />
: <code>wild_flag:int</code>: If set to <code>0</code>, the wildcards found in <code>vms_path</code> are not expanded <br />
;returns<br />
:List of paths in the Unix notation<br />
----<br />
=== getenv(name:str, def_value:str)->str ===<br />
Gets the specified environment variable value. See getenv() description in the '''VSI C Run-Time Library Reference Manual for OpenVMS Systems'''.<br />
;parameters<br />
: <code>name:str</code>: name of the environment variable<br />
: <code>def_value:str</code>: default value<br />
;returns<br />
:Environment variable value<br />
----<br />
=== sleep(seconds:int)->int ===<br />
Suspends execution of the current process or thread for the specified number of seconds.<br />
;parameters<br />
: <code>seconds:int</code>: seconds to sleep<br />
;returns<br />
:The number of seconds left before the sleep timer expires if sleep is interrupted. <code>0</code> if the process slept for the specified number of seconds<br />
----<br />
=== sysconf(name:int)->int ===<br />
Provides a method for determining the current value of a configurable system limit or whether optional features are supported.<br />
;parameters<br />
: <code>name:int</code>: system variable to be queried<br />
;returns<br />
:Requested value<br />
----<br />
=== to_vms(unix_path:str, allow_wild:int, no_directory:int)->list ===<br />
Converts the UNIX style file specifications to the OpenVMS file specifications.<br />
;parameters<br />
: <code>unix_path:str</code>: file name following the Unix file naming conventions<br />
: <code>allow_wild:int</code>: If set to <code>0</code>, the wildcards found in <code>unix_path</code> are not expanded<br />
: <code>no_directory:int</code> An integer that has one of the following values:<br />
:* 0 - Directory allowed<br />
:* 1 - Prevent expansion of the string as a directory name<br />
:* 2 - Force expansion of the string as a directory name<br />
;returns<br />
List of OpenVMS style pathnames<br />
----<br />
=== unixtime(vms_time:int)->int ===<br />
Converts the OpenVMS system time to the Unix local time.<br />
;parameters<br />
: <code>vms_time:int</code> OpenVMS system time<br />
;returns<br />
:Unix time<br />
----<br />
=== vmstime(unix_time:int)->int ===<br />
Converts Unix time to the OpenVMS system time.<br />
;parameters<br />
: <code>unix_time:int</code>: Unix time<br />
;returns<br />
OpenVMS system time<br />
----<br />
=== get_symbol(name:str)->list ===<br />
Requests the calling process’s command language interpreter (CLI) to return the value of a CLI symbol as a string.<br />
;parameters<br />
: <code>name:str</code>: Name of the symbol<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>str</code>: value of the returned symbol<br />
----<br />
=== fopen(path:str, mode:str, ...)->fp:object ===<br />
Opens a file.<br />
;parameters<br />
: <code>path:str</code>: A character string containing a valid file specification<br />
: <code>mode:str</code>: The access mode indicator<br />
: <code>...:str</code>: Optional file attribute arguments<br />
;returns<br />
:*<code>fp:object</code>: File pointer<br />
----<br />
=== fclose(fp:object)->status:int ===<br />
Closes a file.<br />
;parameters<br />
: <code>fp:object</code>: A pointer to the file to be closed<br />
;returns<br />
:*<code>status:int</code>: status code of the operation<br />
----<br />
=== fileno(fp:object)->fd:int ===<br />
Returns the file descriptor associated with the specified file pointer.<br />
;parameters<br />
: <code>fp:object</code>: A pointer to the file<br />
;returns<br />
:*<code>fd:int</code>: Integer file descriptor<br />
----<br />
=== write(fd:int, data:bytes)->nbytes:int ===<br />
Writes bytes to a file.<br />
;parameters<br />
: <code>fd:int</code>: Integer file descriptor<br />
: <code>data:bytes</code>: Bytes to write<br />
;returns<br />
:*<code>nbytes:int</code>: The number of bytes written<br />
----<br />
<br />
=== fgets(fp:object, maxchars:int)->line:str ===<br />
Reads a line from the specified file, up to one less than the specified maximum<br />
number of characters or up to and including the newline character, whichever<br />
comes first.<br />
;parameters<br />
: <code>fp:object</code>: A pointer to the file<br />
: <code>maxchars:int</code>: The maximum number of characters to fetch<br />
;returns<br />
:*<code>line:str</code>: The fetched line<br />
----<br />
<br />
=== feof(fp:object)->status:int ===<br />
Tests a file to see if the end-of-file has been reached.<br />
;parameters<br />
: <code>fp:object</code>: A pointer to the file<br />
;returns<br />
:*<code>status:int</code>: Nonzero integer indicates that the end-of-file has been reached<br />
----<br />
=== ferror(fp:object)->status:int ===<br />
Returns a nonzero integer if an error occurred while reading or writing a file.<br />
;parameters<br />
: <code>fp:object</code>: A pointer to the file<br />
;returns<br />
:*<code>status:int</code>: Nonzero integer indicates that an error has occurred<br />
----<br />
<br />
== vms.ile3 ==<br />
<br>Provides functions to work with item lists.<br><br />
----<br />
=== new()->object ===<br />
Creates an empty item list.<br />
;parameters<br />
: <code>None</code><br />
;returns<br />
:New empty item list<br />
----<br />
=== delete(il:object)->None ===<br />
Deletes the item list.<br />
;parameters<br />
: <code>il:object</code>: item list to be removed<br />
;returns<br />
: <code>None</code><br />
----<br />
=== size(il:object)->int ===<br />
Gets the size of the item list.<br />
;parameters<br />
: <code>il:object</code>: item list<br />
;returns<br />
:The size of the specified item list<br />
----<br />
=== addint(il:object, item:int, item_type:int, item_value:int)->None ===<br />
Adds a new integer to the item list.<br />
;parameters<br />
: <code>il:object</code>: item list<br />
: <code>item:int</code>: item to add<br />
: <code>item_type:int</code>: type of the item. See '''vms.dscdef'''<br />
: <code>item_value:int</code>: value of the item<br />
;returns<br />
: <code>None</code><br />
----<br />
=== getint(il:object, index:int)->int ===<br />
Gets the integer at the specified index in the item list.<br />
;parameters<br />
: <code>il:object</code>: item list<br />
: <code>index:int</code>: index of the item to get<br />
;returns<br />
:Integer value<br />
----<br />
=== gethex(il:object, index:int)->str ===<br />
Gets the integer at the specified index in the item list and returns it as a hexadecimal string.<br />
;parameters<br />
: <code>il:object</code>: item list<br />
: <code>index:int</code>: index of the item to get<br />
;returns<br />
:Hexadecimal string<br />
----<br />
=== addstr(il:object, item:int, item_value:str, item_length:int)->None ===<br />
Adds the specified string to the item list. If <code>item_value</code> is not <code>None</code>, <code>item_length</code> is ignored and the length of the buffer will be the same as the length of <code>item_value</code>.<br />
;parameters<br />
: <code>il:object</code>: item list<br />
: <code>item:int</code>: item to add<br />
: <code>item_value:str</code>: value to add (or <code>None</code>)<br />
: <code>item_length:int</code>: length of the buffer if <code>item_value</code> is <code>None</code><br />
;returns<br />
: <code>None</code><br />
----<br />
=== addstrd(il:object, item:int, item_value:str, item_length:int)->None ===<br />
Adds the specified space-expanded string to the item list. The first byte of the buffer is the length of the string. If <code>item_value</code> is longer than <code>item_length</code>, it will be truncated.<br />
;parameters<br />
: <code>il:object</code>: item list<br />
: <code>item:int</code>: item to add<br />
: <code>item_value:str</code>: value to add<br />
: <code>item_length:int</code>: length of the buffer (the resulting string length is one byte less)<br />
;returns<br />
: <code>None</code><br />
----<br />
=== addstrn(il:object, item:int, item_value:str, item_length:int)->None ===<br />
Adds the specified space-expanded string to the item list. If <code>item_value</code> is longer than <code>item_length</code>, it will be truncated.<br />
;parameters<br />
: <code>il:object</code>: item list<br />
: <code>item:int</code>: item to add<br />
: <code>item_value:str</code>: value to add<br />
: <code>item_length:int</code>: length of the buffer<br />
;returns<br />
: <code>None</code><br />
----<br />
=== getstr(il:object, index:int, flag:int)->str ===<br />
Gets the string at the specified index in the item list.<br />
;parameters<br />
: <code>il:object</code>: item list<br />
: <code>index:int</code>: index of the item to get<br />
: <code>flag:int</code>: if set to <code>1</code>, the first byte of the resulting string is the length of the string<br />
;returns<br />
:String<br />
----<br />
=== addbin(il:object, item:int, item_value:int, item_offset:int, item_len:int)->None ===<br />
Adds a new binary item to the item list. This item will be interpreted as a string.<br />
;parameters<br />
: <code>il:object</code>: item list<br />
: <code>item:int</code>: item to add<br />
: <code>item_value:int</code>: value to store<br />
: <code>item_offset:int</code>: starting byte<br />
: <code>item_len:int</code>: amount of bytes<br />
;returns<br />
:<code>None</code><br />
----<br />
=== getbyte(il:object, index:int, item_offset:int)->int ===<br />
Gets the byte at the specified position in the item list.<br />
;parameters<br />
: <code>il:object</code>: item list<br />
: <code>index:int</code>: index of the item<br />
: <code>item_offset:int</code>: starting byte<br />
;returns<br />
:Integer value of the specified byte<br />
----<br />
<br />
== vms.lib ==<br />
<br>Wraps the '''OpenVMS RTL Library (LIB$)''' functions.<br><br />
----<br />
=== create_dir(name:str, uic:int, pe:int, pv:int)->int ===<br />
Creates a directory.<br />
;parameters<br />
: <code>name:str</code>: name of the directory to be created (following the OpenVMS naming conventions)<br />
: <code>uic:int</code>: unsigned integer value of the owner UIC: <br />
:*<code>None</code>: current user<br />
:*<code>0</code>: owner of the parent directory<br />
: <code>pe:int</code>: protection-enable. Refer to the '''VSI OpenVMS RTL Library (LIB$) Manual''' for more info about LIB$CREATE_DIR.<br />
: <code>pv:int</code>: protection-value<br />
;returns<br />
: <code>vms.ssdef.SS__CREATED</code>: one or more directories created<br />
: <code>vms.ssdef.SS__NORMAL</code>: all the specified directories already exist<br />
: Some other error. See in '''vms.ssdef'''<br />
----<br />
=== date_time()->list ===<br />
Gets current date and time.<br />
;parameters<br />
: <code>None</code><br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>str</code>: resulting string<br />
----<br />
=== get_ef()->list ===<br />
Allocates the local event flag.<br />
;parameters<br />
:<code>None</code><br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code>: resulting event flag<br />
----<br />
=== free_ef(ef:int)->int ===<br />
Releases the local event flag. <br />
;parameters<br />
: <code>ef:int</code>: local event flag<br />
;returns<br />
:Status code of the operation<br />
----<br />
=== put_common(common:str)->int ===<br />
Copies a string into the common area. <br />
;parameters<br />
: <code>common:str</code>: string to copy<br />
;returns<br />
:Status code of the operation<br />
----<br />
=== get_common()->list ===<br />
Gets the string from the common area.<br />
;parameters<br />
: <code>None</code><br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>str</code>: resulting string<br />
----<br />
=== get_hostname(flags:int)->list ===<br />
Gets the host name of the local system.<br />
;parameters<br />
: <code>flags:int</code> if set to <code>1</code>, the host node name is returned in a parseable format<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>str</code>: resulting host node name<br />
----<br />
=== getjpi(item_code:int, pid:int, pname:str)->list ===<br />
Gets the specified job/process information as a string.<br />
;parameters<br />
: <code>item_code:int</code>: item identifier code defining the item of the information to be returned. See '''vms.jpidef'''<br />
: <code>pid:int</code>: process ID<br />
: <code>pname:str</code>: process name<br />
For valid combination of the values of <code>pid</code> and <code>pname</code>, see the '''OpenVMS RTL Library (LIB$) Manual''' for LIB$GETJPI. The resulting <code>pid</code> is not returned.<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>str</code>: resulting string<br />
----<br />
=== getsyi(item_code:int, node_name:str)->list ===<br />
Gets system-wide information as a string.<br />
;parameters<br />
: <code>item_code:int</code>: item identifier code defining the item of the information to be returned. See '''vms.syidef'''<br />
: <code>node_name:str</code>: node name<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>str</code>: resulting string<br />
:*<code>int</code>: resulting cluster system ID<br />
----<br />
=== spawn(command:str, input_file:str, output_file:str, flags:int, pname:str)->list ===<br />
Requests the command language interpreter (CLI) of the calling process to spawn a subprocess for executing CLI commands.<br />
;parameters<br />
: <code>command:str</code>: command to execute<br />
: <code>input_file:str</code>: equivalence name to be associated with the logical name SYS$INPUT<br />
: <code>output_file:str</code>: equivalence name to be associated with the logical name SYS$OUTPUT<br />
: <code>flags:int</code>: flag bits that designate optional behavior. See '''vms.clidef'''<br />
: <code>pname:str</code>: name defined for the subprocess<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code>: process ID of the spawned process<br />
----<br />
=== do_command(command:str)->None ===<br />
Stops program execution and directs the command language interpreter (CLI) to execute a command that is supplied as the argument.<br />
;parameters<br />
: <code>command:str</code>: command to execute<br />
;returns<br />
:If successful, it does not return control to the calling program.<br />
----<br />
<br />
== vms.sys ==<br />
<br>Wraps the '''OpenVMS System Services''' functions.<br><br />
----<br />
=== asctim(vms_time:int, time_only:int)->list ===<br />
Converts an absolute or delta time from 64-bit system time format to an ASCII string.<br />
;parameters<br />
: <code>vms_time:int</code>: OpenVMS system time. A negative time value represents a delta time.<br />
: <code>time_only:int</code>: if set to <code>1</code>, asctim returns the hour only.<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>str</code>: resulting string<br />
----<br />
=== bintim(time_str:str)->list ===<br />
Converts an ASCII string to an absolute or delta time value in the system 64-bit time format.<br />
;parameters<br />
: <code>time_str:str</code> in the following format:<br />
:*Absolute Time: dd-mmm-yyyy hh:mm:ss.cc<br />
:*Delta Time: dddd hh:mm:ss.cc<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code>: resulting time value<br />
----<br />
=== asctoid(name:str)->list ===<br />
Translates the specified identifier name into its binary identifier value.<br />
;parameters<br />
: <code>name:str</code>: identifier name<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code>: resulting identifier value<br />
:*<code>int</code>: resulting identifier attributes. See '''vms.kgbdef'''<br />
----<br />
=== idtoasc(id_val:int, context:int)->list ===<br />
Translates the specified identifier value to the identifier name.<br />
;parameters<br />
: <code>id_val:int</code>: identifier value. See '''OpenVMS System Services Reference Manual''' for SYS$IDTOASC<br />
: <code>context:int</code>: context value used when <code>idtoasc</code> is called repeatedly. Must be initialized with the value <code>0</code>.<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>str</code>: resulting identifier name<br />
:*<code>int</code>: resulting identifier value<br />
:*<code>int</code>: resulting identifier attributes. See '''vms.kgbdef'''<br />
:*<code>int</code>: resulting context<br />
----<br />
=== crembx(tmp:int, maxmsg:int, bufquo:int, promsk:int, acmode:int, mbx_name:string, flags:int)->list ===<br />
Creates a virtual mailbox device.<br />
;parameters<br />
: <code>tmp:int</code>: the first bit specifies a permanent mailbox <br />
: <code>maxmsg:int</code>: maximum size of a message (in bytes)<br />
: <code>bufquo:int</code>: number of bytes of system dynamic memory that can be used to buffer messages sent to the mailbox<br />
: <code>promsk:int</code>: protection mask to be associated with the created mailbox<br />
: <code>acmode:int</code>: access mode to be associated with the channel to which the mailbox is assigned<br />
: <code>mbx_name:string</code>: logical name to be assigned to the mailbox<br />
: <code>flags:int</code>: options for the assign operation. See '''vms.cmbdef'''<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code>: resulting channel<br />
----<br />
=== delmbx(channel:int)->int ===<br />
Marks a permanent mailbox for deletion.<br />
;parameters<br />
: <code>channel:int</code>: mailbox channel<br />
;returns<br />
:Status code<br />
----<br />
=== assign(devnam:str, acmode:int, mbxnam:str, flags:int)->list ===<br />
Provides a process with an I/O channel.<br />
;parameters<br />
: <code>devnam:str</code>: name of the device<br />
: <code>acmode:int</code>: access mode to be associated with the channel<br />
: <code>mbxnam:str</code>: logical name of the mailbox to be associated with the device<br />
: <code>flags:int</code>: an optional device-specific argument<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code>: resulting channel<br />
----<br />
=== dassgn(channel:int)->int ===<br />
Unassigns (releases) an I/O channel.<br />
;parameters<br />
: <code>channel:int</code>: number of the I/O channel to be unassigned<br />
;returns<br />
:Status code<br />
----<br />
=== readvblk(channel:int, max_read:int, block:int, fmod:int)->list ===<br />
Read from the I/O channel.<br />
;parameters<br />
: <code>channel:int</code>: I/O channel<br />
: <code>max_read:int</code>: amount of bytes to read<br />
: <code>block:int</code>: starting block<br />
: <code>fmod:int</code>: function code modifiers<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>byte</code>: resulting buffer<br />
:*<code>int</code>: I/O completion code<br />
----<br />
=== writevblk(channel:int, buffer:bytes, block:int, fmod:int)->list ===<br />
Write to the I/O channel.<br />
;parameters<br />
: <code>channel:int</code>: I/O channel<br />
: <code>buffer:bytes</code>: bytes to write<br />
: <code>block:int</code>: starting block<br />
: <code>fmod:int</code>: function code modifiers<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code>: amount of written bytes<br />
:*<code>int</code>: I/O completion code<br />
----<br />
=== cancel(channel:int)->int ===<br />
Cancel the I/O operation.<br />
;parameters<br />
: <code>channel:int</code>: I/O channel<br />
;returns<br />
:Status code<br />
----<br />
=== crelnm(attr:int, tabnam:str, lognam:str, acmode:int, il:object)->int ===<br />
Creates a logical name and specifies its equivalence names. <br />
;parameters<br />
: <code>attr:int</code>: attributes to be associated with the logical name. See '''vms.lnmdef'''<br />
: <code>tabnam:str</code>: name of the table in which to create the logical name<br />
: <code>lognam:str</code>: logical name to be created<br />
: <code>acmode:int</code>: access mode to be associated with the logical name. See '''vms.psldef'''<br />
: <code>il:object</code>: item list, created via [[VMS specific Python modules#new()->object|<code>vms.ile3.new()</code>]]<br />
See '''OpenVMS System Services Reference Manual''' for SYS$CRELNM.<br />
;returns<br />
:Status code<br />
----<br />
=== trnlnm(attr:int, tabnam:str, lognam:str, acmode:int, il:object)->int ===<br />
Returns information about the specified logical name.<br />
;parameters<br />
: <code>attr:int</code>: attributes controlling the search for the logical name. See '''vms.lnmdef'''<br />
: <code>tabnam:str</code>: name of the logical name table or the name of a searchlist logical name<br />
: <code>lognam:str</code>: logical name for which information is to be returned<br />
: <code>acmode:int</code>: access mode to be used in the translation. See '''vms.psldef'''<br />
: <code>il:object</code>: item list, created via [[VMS specific Python modules#new()->object|<code>vms.ile3.new()</code>]]<br />
See '''OpenVMS System Services Reference Manual''' for SYS$TRNLNM.<br />
;returns<br />
:Status code<br />
----<br />
=== dellnm(tabnam:str, lognam:str, acmode:int)->int ===<br />
Deletes all logical names with the specified name.<br />
;parameters<br />
: <code>tabnam:str</code>: name of a logical name table or the name of a searchlist logical name<br />
: <code>lognam:str</code>: logical name to be deleted<br />
: <code>acmode:int</code>: access mode to be used in the delete operation. See '''vms.psldef'''<br />
;returns<br />
:Status code<br />
----<br />
=== device_scan(search_devnam:str, item_list:object, context:int)->list ===<br />
Returns the names of all devices that match a specified set of search criteria.<br />
;parameters<br />
: <code>search_devnam:str</code>: name of the device for which <code>device_scan</code> to search<br />
: <code>item_list:object</code>: item list specifying search criteria<br />
: <code>context:int</code>: value used to indicate the current position of the search. On the initial call it must contain <code>0</code>.<br />
See '''OpenVMS System Services Reference Manual''' for SYS$DEVICE_SCAN<br />
;returns<br />
:The list:<br />
:* <code>int</code>: status code of the operation<br />
:* <code>str</code>: found device name<br />
:* <code>int</code>: context<br />
----<br />
=== uicstr(uic:int, flags:int)->list ===<br />
Converts UIC to a string.<br />
;parameters<br />
: <code>uic:int</code>: UIC<br />
: <code>flags:int</code> <br />
:*<code>0</code>: use "!%I" SYS$FAO format<br />
:*<code>1</code>: use "!%U" SYS$FAO format<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>str</code>: UIC string<br />
----<br />
=== getdvi(dev_nam:str, item_list:object)->int ===<br />
Returns information related to the primary and secondary device characteristics of an I/O device.<br />
;parameters<br />
: <code>dev_nam:str</code>: the name of the device for which information is to be returned<br />
: <code>item_list:object</code>: item list specifying which information about the device is to be returned<br />
See '''OpenVMS System Services Reference Manual''' for SYS$GETDVI<br />
;returns<br />
:Status code<br />
----<br />
=== getjpi(pid:int, pnam:str, item_list:object)->list ===<br />
Returns information about one or more processes of the system or across the OpenVMS Cluster system.<br />
;parameters<br />
: <code>pid:int</code>: process identification<br />
: <code>pnam:str</code>: name of the process<br />
: <code>item_list:object</code>: item list specifying which information about the process or processes is to be returned<br />
See '''OpenVMS System Services Reference Manual''' for SYS$GETJPI<br />
;returns<br />
:The list:<br />
:* <code>int</code>: status code of the operation<br />
:* <code>int</code>: process ID<br />
----<br />
=== getlki(lki:int, item_list:object)->list ===<br />
Returns information about the lock database on a system.<br />
;parameters<br />
: <code>lki:int</code>: identification of the lock (lock ID) information about which needs to be returned<br />
: <code>item_list:object</code>: item list specifying the lock information to be returned<br />
See '''OpenVMS System Services Reference Manual''' for SYS$GETLKI<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code>: lock identification<br />
----<br />
=== getmsg(msgid:int, flags:int)->list ===<br />
Returns message text associated with a given message identification code.<br />
;parameters<br />
: <code>msgid:int</code>: identification of the message to be retrieved<br />
: <code>flags:int</code>: message components to be returned<br />
See '''OpenVMS System Services Reference Manual''' for SYS$GETMSG<br />
;returns<br />
:The list:<br />
:* <code>int</code>: status code of the operation<br />
:* <code>str</code>: message string<br />
:* <code>int</code>: optional information<br />
----<br />
=== getqui(func:int, context:int, item_list:object)->list ===<br />
Returns information about queues and the jobs initiated from these queues.<br />
;parameters<br />
: <code>func:int</code>: function code specifying the function that <code>getqui</code> is to perform. See '''vms.quidef'''<br />
: <code>context:int</code>: context stream for this call<br />
: <code>item_list:object</code>: item list supplying the information to be used by the function <br />
See '''OpenVMS System Services Reference Manual''' for SYS$GETQUI<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code>: context<br />
----<br />
=== getrmi(item_list:object)->int ===<br />
Returns system performance information about the local system.<br />
;parameters<br />
: <code>item_list:object</code>: item list specifying which information about the local node is to be returned<br />
See '''OpenVMS System Services Reference Manual''' for SYS$GETRMI<br />
;returns<br />
:Status code<br />
----<br />
=== getsyi(csid:int, node_name:str, item_list:object)->list ===<br />
Returns information about the local system or about other systems in an OpenVMS Cluster system.<br />
;parameters<br />
: <code>csid:int</code>: OpenVMS Cluster system identification<br />
: <code>node_name:str</code>: name of the node about which information is to be returned<br />
: <code>item_list:object</code>: item list specifying which information about the node or nodes to return<br />
See '''OpenVMS System Services Reference Manual''' for SYS$GETSYI<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code>: CSID<br />
----<br />
=== gettim()->list ===<br />
Returns the current system time in a 64-bit format.<br />
;parameters<br />
:<code>None</code><br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code>: current system time<br />
----<br />
=== getuai(user_name:str, item_list:object)->int ===<br />
Returns authorization information about the specified user.<br />
;parameters<br />
: <code>user_name:str</code>: name of the user to get authorization information for<br />
: <code>item_list:object</code>: item list specifying which information to return<br />
See '''OpenVMS System Services Reference Manual''' for SYS$GETUAI<br />
;returns<br />
:Status code<br />
----<br />
=== hiber()->int ===<br />
Allows a process to make itself inactive but to remain known to the system so that it can be interrupted.<br />
;parameters<br />
:<code>None</code><br />
;returns<br />
:Status code<br />
----<br />
=== schdwk(pid:int, pname:str, time:int, reptim:int)->list ===<br />
Schedules the awakening (restart) of a process that has placed itself in the state of hibernation with the Hibernate service.<br />
;parameters<br />
: <code>pid:int</code>: process identification (PID) of the process to be awakened<br />
: <code>pname:str</code>: name of the process to be awakened<br />
: <code>time:int</code>: time at which the process is to be awakened<br />
: <code>reptim:int</code>: time interval at which the wakeup request is to be repeated<br />
See '''OpenVMS System Services Reference Manual''' for SYS$SCHDWK<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code>: PID<br />
----<br />
<br />
=== add_holder(id:int, holder:int, attrib:int)->int ===<br />
Adds the specified holder record to the target identifier.<br />
;parameters<br />
: <code>id:int</code>: target identifier granted to the specified holder<br />
: <code>holder:int</code>: holder identifier that is granted access to the target identifier<br />
: <code>attrib:int</code>: attributes to be placed in the holder record<br />
See '''OpenVMS System Services Reference Manual''' for SYS$ADD_HOLDER<br />
;returns<br />
:Status code<br />
----<br />
=== add_ident(name:str, id:int, attrib:int)->list ===<br />
Adds the specified identifier to the rights database.<br />
;parameters<br />
: <code>name:str</code>: identifier name to be added to the rights database<br />
: <code>id:int</code>: identifier to be created<br />
: <code>attrib:int</code>: attributes placed in the identifier’s record<br />
See '''OpenVMS System Services Reference Manual''' for SYS$ADD_IDENT<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code> <code>resid</code>: identifier value assigned by the system<br />
----<br />
=== find_held(holder:int, context:int)->list ===<br />
Returns the identifiers held by the specified holder.<br />
;parameters<br />
: <code>holder:int</code>: holder whose identifiers to be found<br />
: <code>context:int</code>: context value used when <code>find_held</code> is called repeatedly<br />
See '''OpenVMS System Services Reference Manual''' for SYS$FIND_HELD<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>int</code> <code>id</code>: identifier value that was found<br />
:*<code>int</code> <code>attrib</code>: attributes associated with the holder returned in <code>id</code><br />
:*<code>int</code> <code>context</code><br />
----<br />
=== finish_rdb(context:int)->int ===<br />
Deallocates the record stream and clears the context value.<br />
;parameters<br />
: <code>context:int</code>: context value to be cleared<br />
;returns<br />
:Status code<br />
----<br />
=== forcex(pid:int, pname:str, code:int)->int ===<br />
Causes an Exit ($EXIT) service call to be issued on behalf of a specified process.<br />
;parameters<br />
: <code>pid:int</code>: process identification (PID) of the process to force exit<br />
: <code>pname:str</code>: process name of the process that is to force exit<br />
: <code>code:int</code>: completion code value to be used as the exit parameter<br />
;returns<br />
:Status code<br />
----<br />
=== rem_holder(id:int, holder:int)->int ===<br />
Deletes the specified holder record from the target identifier’s list of holders.<br />
;parameters<br />
: <code>id:int</code>: binary value of the target identifier<br />
: <code>holder:int</code>: identifier of the holder being deleted<br />
;returns<br />
:Status code<br />
----<br />
=== rem_ident(id:int)->int ===<br />
Removes the specified identifier record and all its holder records (if any) from the rights database. <br />
;parameters<br />
: <code>id:int</code>: binary value of the identifier deleted from rights database<br />
;returns<br />
:Status code<br />
----<br />
=== setuai(user_name:str, item_list:object)->int ===<br />
Modifies the user authorization file (UAF) record for the specified user.<br />
;parameters<br />
: <code>user_name:str</code>: name of the user whose UAF record is modified<br />
: <code>item_list:object</code>: item list specifying which information from the specified UAF record is to be modified<br />
See '''OpenVMS System Services Reference Manual''' for SYS$SETUAI<br />
;returns<br />
:Status code<br />
----<br />
=== show_intrusion(user_criteria:str, flags:int, context:int)->list ===<br />
Searches for and returns information about records in the intrusion database matching the caller specifications.<br />
;parameters<br />
: <code>user_criteria:str</code>: description of an intruder or suspect<br />
: <code>flags:int</code>: type of records in the intrusion database about which information is to be returned. NOTE: do not use ''vms.ciadef.CIA_M_ITEMLIST'', because <code>user_criteria</code> is a string<br />
: <code>context:int</code>: context information to keep between related calls<br />
See '''OpenVMS System Services Reference Manual''' for SYS$SETUAI<br />
;returns<br />
:The list:<br />
:*<code>int</code>: status code of the operation<br />
:*<code>str</code> <code>intruder</code>: user specification of the matched intruder or suspect record in the intrusion database<br />
:*<code>int</code> <code>expires</code>: quadword time format indicating the time when the record will expire<br />
:*<code>int</code> <code>type</code>: the types of the matched record and the status of the suspect<br />
:*<code>int</code> <code>count</code>: number of login failures or break-in attempts<br />
----<br />
<br />
== rdb ==<br />
<br>Wraps the '''Oracle Rdb''' functions.<br />
----<br />
=== Attach(dbname:string)->int ===<br />
Attaches to the specified database. The string may specify the full path to the Rdb database in the OpenVMS format or (more commonly) a logical name pointing to the database.<br />
;parameters<br />
: <code>dbname:string</code>: path or logical name<br />
;returns<br />
:Status code:<br />
:* <code>0</code>: success<br />
:* <code>-1</code>: failed<br />
----<br />
=== CloseCursor(cursor:object)->int === <br />
Closes the specified cursor.<br />
;parameters<br />
: <code>cursor:object</code>: cursor<br />
;returns<br />
:Status code:<br />
:*<code>0</code>: success<br />
:*<code>-1</code>: failed<br />
----<br />
=== Commit()->int ===<br />
Commits the current database transaction.<br />
;parameters<br />
:<code>None</code><br />
;returns<br />
:Status code:<br />
:*<code>0</code>: success<br />
:*<code>-1</code>: failed<br />
----<br />
=== Data(cursor:object, idx:int)->str ===<br />
Given a cursor handle and column index (integer), returns the data value for the specified column for the last fetch operation.<br />
;parameters<br />
: <code>cursor:object</code>: cursor<br />
: <code>idx:int</code>: index<br />
;returns<br />
:Resulting string<br />
----<br />
=== DeclareCursor(name:str, statement:str)->object ===<br />
Declares a cursor. Inputs are the name for the cursor and the SQL statement. On success the function returns a cursor handle that can be used with <code>OpenCursor()</code>, <code>FetchCursor()</code>, and <code>CloseCursor()</code>.<br />
;parameters<br />
: <code>name:str</code>: name for the cursor<br />
: <code>statement:str</code>: SQL statement<br />
;returns<br />
:Resulting cursor<br />
----<br />
=== Detach()->int ===<br />
Disconnects from the database.<br />
;parameters<br />
<code>None</code><br />
;returns<br />
:Status code:<br />
:*<code>0</code>: success<br />
:*<code>-1</code>: failed<br />
----<br />
=== Error()->str ===<br />
Returns a description of the last error.<br />
;parameters<br />
: <code>None</code><br />
;returns<br />
:Resulting error string<br />
----<br />
=== Exec(sh:object)->int ===<br />
Executes a previously prepared SQL statement.<br />
;parameters<br />
: <code>sh:object</code>: prepared SQL statement<br />
;returns<br />
:Status code:<br />
:*<code>0</code>: success<br />
:*<code>-1</code>: failed<br />
----<br />
=== ExecI(st:str)->int ===<br />
Executes the supplied SQL statement immediately.<br><br />
'''Note: the last letter is a capital 'i'<br />
;parameters<br />
: <code>st:str</code>: SQL statement<br />
;returns<br />
:Status code:<br />
:*<code>0</code>: success<br />
:*<code>-1</code>: failed<br />
----<br />
=== Fetch(cursor:object)->int ===<br />
Fetches a row of data for the specified cursor but does not explicitly return the fetched data. The <code>Data()</code> method can then be used to retrieve individual data values for each column (<code>Ncol()</code> can be used to determine the number of columns).<br />
;parameters<br />
: <code>cursor:object</code>: cursor<br />
;returns<br />
:Status code:<br />
:*<code>1</code>: success<br />
:*<code>0</code>: success, end of stream<br />
:*<code>-1</code>: failed<br />
----<br />
=== FetchRow(cursor:object)->list ===<br />
Fetches a row of data using the specified cursor handle. The fetched data is returned as a list of strings.<br />
;parameters<br />
: <code>cursor:object</code>: cursor<br />
;returns<br />
:The list of strings<br />
----<br />
=== Free(cursor:object)->int ===<br />
Frees resources associated with the supplied cursor handle for a cursor previously declared via <code>DeclareCursor()</code>.<br />
;parameters<br />
: <code>cursor:object</code>: cursor<br />
;returns<br />
:Status code:<br />
:*<code>0</code>: success<br />
----<br />
=== Ncol(cursor:object)->int ===<br />
Returns the number of columns (values) that would be returned by a fetch for the specified cursor.<br />
;parameters<br />
: <code>cursor:object</code>: cursor<br />
;returns<br />
:Number of columns<br />
----<br />
=== OpenCursor(cursor:object)->int ===<br />
Opens a cursor using the supplied (previously declared) cursor handle.<br />
;parameters<br />
: <code>cursor:object</code>: cursor<br />
;returns<br />
:Status code:<br />
:*<code>0</code>: success<br />
:*<code>-1</code>: failed<br />
----<br />
=== Prepare(st:string)->object ===<br />
Prepares an SQL statement and returns a handle for the prepared statement that can be used in subsequent calls to Exec().<br />
;parameters<br />
: <code>st:string</code>: SQL statement<br />
;returns<br />
:Resulting prepared statement<br />
----<br />
=== Rollback()->int ===<br />
Rolls back the current database transaction.<br />
;parameters<br />
:<code>None</code><br />
;returns<br />
:Status code:<br />
:*<code>0</code>: success<br />
:*<code>-1</code>: failed<br />
----<br />
=== SetReadonly()->int ===<br />
Starts a read-only transaction.<br />
;parameters<br />
:<code>None</code><br />
;returns<br />
:Status code:<br />
:*<code>0</code>: success<br />
:*<code>-1</code>: failed<br />
----<br />
=== Sqlcode()->int ===<br />
Returns the SQLCODE for the last database operation.<br />
;parameters<br />
:<code>None</code><br />
;returns<br />
:Resulting SQL code<br />
----<br />
<br />
== RMS ==<br />
<br>Working with RMS.<br><br />
----<br />
=== BCD2String(bcd:bytes, prec:int)->str ===<br />
Converts BCD to string.<br />
;parameters<br />
: <code>bcd:bytes</code>: BCD<br />
: <code>prec:int</code>: precision<br />
;returns<br />
: <code>str</code>: BCD number as a string<br />
----<br />
<br />
=== String2BCD(repr:str, l:int, prec:int)->bytes ===<br />
Converts string to BCD.<br />
;parameters<br />
: <code>repr:str</code>: string representation of the BCD number<br />
: <code>l:int</code>: length<br />
: <code>prec:int</code>: precision<br />
;returns<br />
: <code>bytes</code>: BCD from string<br />
----<br />
<br />
=== BCD2Tuple(bcd:bytes, prec:int)->tuple ===<br />
Converts BCD to tuple: (sign, (digits,), precision).<br />
;parameters<br />
: <code>bcd:bytes</code>: BCD<br />
: <code>prec:int</code>: precision<br />
;returns<br />
: <code>tuple</code>: BCD parsed to a tuple<br />
----<br />
<br />
=== Tuple2BCD(repr:tuple, l:int, prec:int)->bytes ===<br />
Converts tuple to BCD.<br />
;parameters<br />
: <code>repr:tuple</code>: tuple representation of the BCD number<br />
: <code>l:int</code>: length<br />
: <code>prec:int</code>: precision<br />
;returns<br />
: <code>bytes</code>: BCD from tuple<br />
----<br />
<br />
=== getrmsattr(path:str, attr:int)->int ===<br />
Gets an RMS attribute.<br />
;parameters<br />
: <code>path:str</code>: VMS path to the file<br />
: <code>attr:int</code>: attribute to retrieve<br />
;returns<br />
: <code>attr:int</code>: attribute value<br />
----<br />
<br />
=== parse(path:str)->tuple ===<br />
Parses the VMS path to a tuple of bytes: (node, disk, directory, name, extension, version)<br />
;parameters<br />
: <code>path:str</code>: VMS path to the file<br />
;returns<br />
: <code>tuple</code>: parsed path<br />
----<br />
<br />
=== file(name:str, fac:int, shr:int, fop:int)->rmsFile ===<br />
Opens a file<br />
;parameters<br />
: <code>path:str</code>: VMS path to the file<br />
: <code>fac:int</code>: file access<br />
: <code>shr:int</code>: sharing options<br />
: <code>fop:int</code>: file processing options<br />
;returns<br />
: <code>file:rmsFile</code>: rmsFile object<br />
----<br />
<br />
=== RMS file object ===<br />
<br />
==== Members ====<br />
===== longname =====<br />
Full path to the file<br />
===== nok =====<br />
Number of keys<br />
===== org =====<br />
File organization<br />
----<br />
==== Methods ====<br />
===== close =====<br />
close() -> status<br><br />
Closes file.<br />
----<br />
===== delete =====<br />
delete([key]) -> status<br><br />
Deletes the current record or the first record with the given key.<br />
----<br />
===== fetch =====<br />
fetch([key]) -> status, record<br><br />
Retrieves the record from a file.<br />
----<br />
===== find =====<br />
find([key]) -> status<br><br />
Locates the specified record and establishes it as the current record.<br />
----<br />
===== flush =====<br />
flush() -> status<br><br />
Writes out all modified I/O buffers and file attributes associated with the file.<br />
----<br />
===== free =====<br />
free() -> status<br><br />
Unlocks all records that were previously locked for the record stream.<br />
----<br />
===== put =====<br />
put(record) -> status<br><br />
Inserts a record into a file.<br />
----<br />
===== release =====<br />
release() -> status<br><br />
Unlocks the record.<br />
----<br />
===== rewind =====<br />
rewind([keynum]) -> status<br><br />
Sets the context of a record stream to the first record in the file.<br />
----<br />
===== update =====<br />
update(record) -> status<br><br />
Allows to modify the contents of an existing record in a file residing on a disk device.<br />
----<br />
===== usekey =====<br />
usekey([keynum]) -> status<br><br />
Specifies the key or index to which the operation applies.<br />
----<br />
===== setrop =====<br />
setrop(rop) -> status<br><br />
Specifies which of the various optional record operations are to be implemented for the program.<br />
----<br />
<br />
=See also=<br />
* {{Template:CRuntime}}<br />
* {{Template:RTLLibrary}}<br />
* {{Template:SyservI}}<br />
* {{Template:SyservII}}<br />
<br />
[[Category:VMS Python]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=User:Brett.cameron&diff=2408User:Brett.cameron2021-09-17T05:14:04Z<p>Brett.cameron: Created page with "TBD"</p>
<hr />
<div>TBD</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_Python_compatibility_issues&diff=2108VMS Python compatibility issues2020-09-13T00:58:58Z<p>Brett.cameron: </p>
<hr />
<div>#File system<br />
##Directories and files with the same name are allowed<br />
##Files have versioning, therefore two files with the same name might have different content<br />
##Shared stream I/O does not work<br />
##To guarantee the file content is on the disk the <code>fsync()</code> function must be used<br />
##Because files can be referenced using logical names the real file path may be different from the “path” used to open a file<br />
##Files has no access time attribute<br />
##Changing a files permissions also changes its modification time<br />
##Changing the content of a directory does not change the directory modification time.<br />
##Files have four rights bits (read, write, execute, and delete); Linux (UNIX) has only three (read, write, and execute)<br />
##The ‘.DIR’ extension is reserved<br />
##Non-blocking file IO is not supported by the OpenVMS CRTL<br />
##There are various known issues with symbolic link implementation<br />
##The symbol '$' is commonly used in file and directory names<br />
##On OpenVMS chmod(0) sets the user's default permissions as opposed to resetting permissions<br />
##To delete a directory the user has to have ‘delete’ permission for the directory<br />
##On OpenVMS <code>mkdir()</code> creates all intermediate directories (if required)<br />
#Process<br />
##There are no Linux-like <code>fork()</code> and <code>spawn()</code> functions<br />
##Pipes are created via mailbox and are not totally compatible with UNIX pipes (compatibility issues)<br />
##If a child process has threads, each thread posts 'END-OF-PIPE' when the child completes/terminates<br />
##The functions <code>select()</code> and <code>poll()</code> work only with sockets<br />
##The function <code>siginterrupt()</code> is not supported<br />
##Numerous compatibility issues with signals<br />
##Interrupting I/O operations may cause the process to hang<br />
##There is no root user with zero UID<br />
##Processes do not handle recursion overflow cleanly<br />
#Sockets<br />
##<code>AF_UNIX</code> has somewhat different meaning<br />
##Binding a socket to an empty address fails (wildcard resolved to multiple address)<br />
##<code>getpeername()</code> returns ‘0.0.0.0’ instead of an error<br />
##<code>socket.socket.sendall</code> does not work correctly (process may crash)<br />
#Time<br />
##<code>time_t</code> is unsigned<br />
##<code>strftime()</code><br />
##*Does not support <code>%G</code> format<br />
##*Exhibits undefined behavior when format ends with <code>%</code><br />
##*<code>%4Y</code> is padded with spaces<br />
#Miscellaneous<br />
##There is no appropriate way to programmatically get all environment variables (logical names and/or symbols)<br />
##The current OpenVMS port of sqlite3 does not support "OR ROLLBACK"<br />
##<code>locale.strxfrm()</code> does not work as expected<br />
#Compiler<br />
##<code>uint_ptr</code> is always 64-bit, <code>void*</code> is either 32-bit or 64-bit (depending on selected pointer size)<br />
##Compiler does not support relative include paths<br />
----<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_Python_compatibility_issues&diff=2107VMS Python compatibility issues2020-09-13T00:54:16Z<p>Brett.cameron: </p>
<hr />
<div>#File system<br />
##Directories and files with the same name are allowed<br />
##Files have versioning, therefore two files with the same name might have different content<br />
##Shared stream I/O does not work<br />
##To guarantee the file content is on the disk the <code>fsync()</code> function must be used<br />
##Because files can be referenced using logical names the real file path may be different from the “path” used to open a file<br />
##Files has no access time attribute<br />
##Changing a files permissions also changes its modification time<br />
##Changing the content of a directory does not change the directory modification time.<br />
##Files have four rights bits (read, write, execute, and delete); Linux (UNIX) has only three (read, write, and execute)<br />
##The ‘.DIR’ extension is reserved<br />
##Non-blocking file IO is not supported by the OpenVMS CRTL<br />
##There are various known issues with symbolic link implementation<br />
##The symbol '$' is commonly used in file and directory names<br />
##On OpenVMS chmod(0) sets the user's default permissions as opposed to resetting permissions<br />
##To delete a directory the user has to have ‘delete’ permission for the directory<br />
##On OpenVMS <code>mkdir()</code> creates all intermediate directories (if required)<br />
#Process<br />
##There are no Linux-like <code>fork()</code> and <code>spawn()</code> functions<br />
##Pipes are created via mailbox and are not totally compatible with UNIX pipes (compatibility issues)<br />
##If a child process has threads, each thread posts 'END-OF-PIPE' when the child completes/terminates<br />
##The functions <code>select()</code> and <code>poll()</code> work only with sockets<br />
##The function <code>siginterrupt()</code> is not supported<br />
##Numerous compatibility issues with signals<br />
##Interrupting I/O operations may cause the process to hang<br />
##There is no root user with zero UID<br />
##Processes do not handle recursion overflow cleanly<br />
#Sockets<br />
##<code>AF_UNIX</code> has somewhat different meaning<br />
##Binding a socket to an empty address fails (wildcard resolved to multiple address)<br />
##<code>getpeername()</code> returns ‘0.0.0.0’ instead of an error<br />
##OpenVMS crashed on <code>socket.socket.sendall</code><br />
#Time<br />
##<code>time_t</code> is unsigned<br />
##<code>strftime()</code><br />
##*Does not support <code>%G</code> format<br />
##*Exhibits undefined behavior when format ends with <code>%</code><br />
##*<code>%4Y</code> is padded with spaces<br />
#Miscellaneous<br />
##There is no appropriate way to programmatically get all environment variables (logical names and/or symbols)<br />
##The current OpenVMS port of sqlite3 does not support "OR ROLLBACK"<br />
##Program prints crush dump<br />
##<code>locale.strxfrm()</code> does not work as expected<br />
#Compiler<br />
##<code>uint_ptr</code> is always 64-bit, <code>void*</code> is either 32-bit or 64-bit (depending on selected pointer size)<br />
##Compiler does not support relative include paths<br />
----<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_Python_compatibility_issues&diff=2106VMS Python compatibility issues2020-09-13T00:42:44Z<p>Brett.cameron: </p>
<hr />
<div>#File system<br />
##Directories and files with the same name are allowed<br />
##Files have versioning, therefore two files with the same name might have different content<br />
##Shared stream I/O does not work<br />
##To guarantee the file content is on the disk the <code>fsync()</code> function must be used<br />
##Because files can be referenced using logical names the real file path may be different from the “path” used to open a file<br />
##Files has no access time attribute<br />
##Changing a files permissions also changes its modification time<br />
##Changing the content of a directory does not change the directory modification time.<br />
##Files have four rights bits (read, write, execute, and delete); Linux (UNIX) has only three (read, write, and execute)<br />
##The ‘.DIR’ extension is reserved<br />
##Non-blocking file IO is not supported by the OpenVMS CRTL<br />
##There are various known issues with symbolic link implementation<br />
##The symbol '$' is commonly used in file and directory names<br />
##On OpenVMS chmod(0) sets the user's default permissions as opposed to resetting permissions<br />
##To delete a directory the user has to have ‘delete’ permission for the directory<br />
##On OpenVMS <code>mkdir()</code> creates all intermediate directories (if required)<br />
#Process<br />
##There are no Linux-like <code>fork()</code> and <code>spawn()</code> functions<br />
##Pipes are created via mailbox and are not totally compatible with UNIX pipes (compatibility issues)<br />
##If a child process has threads, each thread posts 'END-OF-PIPE' when the child completes/terminates<br />
##The functions <code>select()</code> and <code>poll()</code> work only with sockets<br />
##The function <code>siginterrupt()</code> is not supported<br />
##Numerous compatibility issues with signals<br />
##Interrupting I/O operations may cause the process to hang<br />
##There is no root user with zero UID<br />
##Processes do not handle recursion overflow cleanly<br />
#Sockets<br />
##<code>AF_UNIX</code> has different meaning<br />
##Binding socket to empty address fails (wildcard resolved to multiple address).<br />
##<code>getpeername()</code> returns ‘0.0.0.0’ instead of error<br />
##OpenVMS crashed on <code>socket.socket.sendall</code><br />
#Time<br />
##<code>time_t</code> is unsigned<br />
##<code>strftime()</code><br />
##*Does not support <code>%G</code> format<br />
##*Exhibits undefined behavior when format ends with <code>%</code><br />
##*<code>%4Y</code> is padded with spaces<br />
#Miscellaneous<br />
##Environment variables have unusual implementation - through logical names. There is no appropriate way to get all environment variables.<br />
##The OpenVMS sqlite3 port does not support "OR ROLLBACK"<br />
##Program prints crush dump<br />
##<code>locale.strxfrm()</code> works unusual<br />
#Compiler<br />
##<code>uint_ptr</code> is always 64 bit, void* is 32 bit or 64 bit<br />
##Compiler does not support relative include paths<br />
----<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_Python_compatibility_issues&diff=2105VMS Python compatibility issues2020-09-13T00:41:14Z<p>Brett.cameron: </p>
<hr />
<div>#File system<br />
##Directories and files with the same name are allowed<br />
##Files have versioning, therefore two files with the same name might have different content<br />
##Shared stream I/O does not work<br />
##To guarantee the file content is on the disk the <code>fsync()</code> function must be used<br />
##Because files can be referenced using logical names the real file path may be different from the “path” used to open a file<br />
##Files has no access time attribute<br />
##Changing a files permissions also changes its modification time<br />
##Changing the content of a directory does not change the directory modification time.<br />
##Files have four rights bits (read, write, execute, and delete); Linux (UNIX) has only three (read, write, and execute)<br />
##The ‘.DIR’ extension is reserved<br />
##Non-blocking file IO is not supported by the OpenVMS CRTL<br />
##There are various known issues with symbolic link implementation<br />
##The symbol '$' is commonly used in file and directory names<br />
##On OpenVMS chmod(0) sets the user's default permissions as opposed to resetting permissions<br />
##To delete a directory the user has to have ‘delete’ permission for the directory<br />
##On OpenVMS <code>mkdir()</code> creates all intermediate directories (if required)<br />
#Process<br />
##There are no Linux-like <code>fork()</code> and <code>spawn()</code> functions<br />
##Pipes are created via mailbox and are not totally compatible with UNIX pipes (compatibility issues)<br />
##If a child process has threads, each thread posts 'END-OF-PIPE' when the child completes/terminates<br />
##The functions <code>select()</code> and <code>poll()</code> work only with sockets<br />
##The function <code>siginterrupt()</code> is not supported<br />
##Numerous compatibility issues with signals<br />
##Interrupting I/O operations may cause the process to hang<br />
##There is no root user with zero UID<br />
##Processes do not handle recursion overflow cleanly<br />
#Sockets<br />
##<code>AF_UNIX</code> has different meaning<br />
##Binding socket to empty address fails (wildcard resolved to multiple address).<br />
##<code>getpeername()</code> returns ‘0.0.0.0’ instead of error<br />
##OpenVMS crashed on <code>socket.socket.sendall</code><br />
#Time<br />
##<code>time_t</code> is unsigned<br />
##<code>strftime()</code><br />
##*Does not support <code>%G</code> format<br />
##*Exhibits undefined behavior when format ends with <code>'%'</code><br />
##*<code>‘%4Y’</code> is padded with spaces<br />
#Miscellaneous<br />
##Environment variables have unusual implementation - through logical names. There is no appropriate way to get all environment variables.<br />
##OpenVMS sqlite3 port does not support "OR ROLLBACK"<br />
##Program prints crush dump<br />
##<code>locale.strxfrm()</code> works unusual<br />
#Compiler<br />
##<code>uint_ptr</code> is always 64 bit, void* is 32 bit or 64 bit<br />
##Compiler does not support relative include paths<br />
----<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_Python_compatibility_issues&diff=2104VMS Python compatibility issues2020-09-13T00:38:00Z<p>Brett.cameron: </p>
<hr />
<div>#File system<br />
##Directories and files with the same name are allowed<br />
##Files have versioning, therefore two files with the same name might have different content<br />
##Shared stream I/O does not work<br />
##To guarantee the file content is on the disk the <code>fsync()</code> function must be used<br />
##Because files can be referenced using logical names the real file path may be different from the “path” used to open a file<br />
##Files has no access time attribute<br />
##Changing a files permissions also changes its modification time<br />
##Changing the content of a directory does not change the directory modification time.<br />
##Files have four rights bits (read, write, execute, and delete); Linux (UNIX) has only three (read, write, and execute)<br />
##The ‘.DIR’ extension is reserved<br />
##Non-blocking file IO is not supported by the OpenVMS CRTL<br />
##There are various known issues with symbolic link implementation<br />
##The symbol '$' is commonly used in file and directory names<br />
##On OpenVMS chmod(0) sets the user's default permissions as opposed to resetting permissions<br />
##To delete a directory the user has to have ‘delete’ permission for the directory<br />
##On OpenVMS <code>mkdir()</code> creates all intermediate directories (if required)<br />
#Process<br />
##There are no Linux-like <code>fork()</code> and <code>spawn()</code> functions<br />
##Pipes are created via mailbox and are not totally compatible with UNIX pipes (compatibility issues)<br />
##If a child process has threads, each thread posts 'END-OF-PIPE' when the child completes/terminates<br />
##The functions <code>select()</code> and <code>poll()</code> work only with sockets<br />
##The function <code>siginterrupt()</code> is not supported<br />
##Numerous compatibility issues with signals<br />
##Interrupting I/O operations may cause the process to hang<br />
##There is no root user with zero UID<br />
##There is no unix commands like: echo, exit …<br />
##OpenVMS cannot handle recursion overflow properly - just crashes<br />
#Sockets<br />
##<code>AF_UNIX</code> has different meaning<br />
##Binding socket to empty address fails (wildcard resolved to multiple address).<br />
##<code>getpeername()</code> returns ‘0.0.0.0’ instead of error<br />
##OpenVMS crashed on <code>socket.socket.sendall</code><br />
#Time<br />
##<code>time_t</code> is unsigned<br />
##<code>strftime()</code><br />
##*Does not support %G format<br />
##*Undefined behavior when format ends with '%'<br />
##*‘%4Y’ is padded with spaces<br />
#Miscellaneous<br />
##Environment variables have unusual implementation - through logical names. There is no appropriate way to get all environment variables.<br />
##OpenVMS sqlite3 port does not support "OR ROLLBACK"<br />
##Program prints crush dump<br />
##<code>locale.strxfrm()</code> works unusual<br />
#Compiler<br />
##<code>uint_ptr</code> is always 64 bit, void* is 32 bit or 64 bit<br />
##Compiler does not support relative include paths<br />
----<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_Python_compatibility_issues&diff=2103VMS Python compatibility issues2020-09-13T00:33:58Z<p>Brett.cameron: </p>
<hr />
<div>#File system<br />
##Directories and files with the same name are allowed<br />
##Files have versioning, therefore two files with the same name might have different content<br />
##Shared stream I/O does not work<br />
##To guarantee the file content is on the disk the <code>fsync()</code> function must be used<br />
##Because files can be referenced using logical names the real file path may be different from the “path” used to open a file<br />
##Files has no access time attribute<br />
##Changing a files permissions also changes its modification time<br />
##Changing the content of a directory does not change the directory modification time.<br />
##Files have four rights bits (read, write, execute, and delete); Linux (UNIX) has only three (read, write, and execute)<br />
##The ‘.DIR’ extension is reserved<br />
##Non-blocking file IO is not supported by the OpenVMS CRTL<br />
##There are various known issues with symbolic link implementation<br />
##The symbol '$' is commonly used in file and directory names<br />
##On OpenVMS chmod(0) sets the user's default permissions as opposed to resetting permissions<br />
##To delete a directory the user has to have ‘delete’ permission for the directory<br />
##On OpenVMS <code>mkdir()</code> creates all intermediate directories (if required)<br />
#Process<br />
##There are no Linux-like <code>fork()</code> and <code>spawn()</code> functions<br />
##Pipes are created via mailbox and are not totally compatible with UNIX pipes (compatibility issues)<br />
##If a child process has threads, each thread posts 'END-OF-PIPE' when the child completes/terminates<br />
##The functions <code>select()</code> and <code>poll()</code> work only with sockets<br />
##The function <code>siginterrupt()</code> is not supported<br />
##A lot of issues with signals<br />
##Interrupting I/O operation may hang<br />
##There is no root user with zero uid<br />
##There is no unix commands like: echo, exit …<br />
##OpenVMS cannot handle recursion overflow properly - just crashes<br />
#Sockets<br />
##<code>AF_UNIX</code> has different meaning<br />
##Binding socket to empty address fails (wildcard resolved to multiple address).<br />
##<code>getpeername()</code> returns ‘0.0.0.0’ instead of error<br />
##OpenVMS crashed on <code>socket.socket.sendall</code><br />
#Time<br />
##<code>time_t</code> is unsigned<br />
##<code>strftime()</code><br />
##*Does not support %G format<br />
##*Undefined behavior when format ends with '%'<br />
##*‘%4Y’ is padded with spaces<br />
#Miscellaneous<br />
##Environment variables have unusual implementation - through logical names. There is no appropriate way to get all environment variables.<br />
##OpenVMS sqlite3 port does not support "OR ROLLBACK"<br />
##Program prints crush dump<br />
##<code>locale.strxfrm()</code> works unusual<br />
#Compiler<br />
##<code>uint_ptr</code> is always 64 bit, void* is 32 bit or 64 bit<br />
##Compiler does not support relative include paths<br />
----<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_Python_compatibility_issues&diff=2102VMS Python compatibility issues2020-09-13T00:11:19Z<p>Brett.cameron: </p>
<hr />
<div>#File system<br />
##Directories and files with the same name are allowed<br />
##Files have versioning, therefore two files with the same name might have different content<br />
##Shared stream I/O does not work<br />
##To guarantee the file content is on the disk the <code>fsync()</code> function must be used<br />
##Because files can be referenced using logical names the real file path may be different from the “path” used to open a file<br />
##Files has no access time attribute<br />
##Changing a files permissions also changes its modification time<br />
##Changing the content of a directory does not change the directory modification time.<br />
##Files have four rights bits (read, write, execute, and delete); Linux (UNIX) has only three (read, write, and execute)<br />
##The ‘.DIR’ extension is reserved<br />
##Non-blocking file IO is not supported by the OpenVMS CRTL<br />
##There are various known issues with symbolic link implementation<br />
##The symbol '$' is commonly used in file and directory names<br />
##On OpenVMS chmod(0) sets the user's default permissions as opposed to resetting permissions<br />
##To delete a directory the user has to have ‘delete’ permission for the directory<br />
##On OpenVMS <code>mkdir()</code> creates all intermediate directories (if required)<br />
#Process<br />
##There is no normal <code>fork()</code>, <code>spawn()</code> function.<br />
##Pipes are created via mailbox and have a lot of compatibility issues.<br />
##If child has threads, each thread posts 'END-OF-PIPE' when it finishes.<br />
##There is no normal <code>select()</code>, <code>poll()</code> e.t.c<br />
##<code>siginterrupt()</code> is not supported<br />
##A lot of issues with signals<br />
##Interrupting I/O operation may hang<br />
##There is no root user with zero uid<br />
##There is no unix commands like: echo, exit …<br />
##OpenVMS cannot handle recursion overflow properly - just crashes<br />
#Sockets<br />
##<code>AF_UNIX</code> has different meaning<br />
##Binding socket to empty address fails (wildcard resolved to multiple address).<br />
##<code>getpeername()</code> returns ‘0.0.0.0’ instead of error<br />
##OpenVMS crashed on <code>socket.socket.sendall</code><br />
#Time<br />
##<code>time_t</code> is unsigned<br />
##<code>strftime()</code><br />
##*Does not support %G format<br />
##*Undefined behavior when format ends with '%'<br />
##*‘%4Y’ is padded with spaces<br />
#Miscellaneous<br />
##Environment variables have unusual implementation - through logical names. There is no appropriate way to get all environment variables.<br />
##OpenVMS sqlite3 port does not support "OR ROLLBACK"<br />
##Program prints crush dump<br />
##<code>locale.strxfrm()</code> works unusual<br />
#Compiler<br />
##<code>uint_ptr</code> is always 64 bit, void* is 32 bit or 64 bit<br />
##Compiler does not support relative include paths<br />
----<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_Python_compatibility_issues&diff=2101VMS Python compatibility issues2020-09-12T23:54:50Z<p>Brett.cameron: </p>
<hr />
<div>#File system<br />
##Directories and files with the same name are allowed.<br />
##File has a version, therefore two files with the same name might have different content.<br />
##Shared stream I/O does not work.<br />
##To guarantee the file content is on the disk the <code>fsync()</code> function must be used.<br />
##Because of using logical names the real file path may be different from path used to open file.<br />
##Files has no access time attribute.<br />
##Changing a files permissions also changes its modification time.<br />
##Changing the content of a directory does not change the directory modification time.<br />
##File has four rights bits - read, write, execute and delete. In unix it has three of it - read, write and execute. <br />
##‘.DIR’ extension is reserved<br />
##Non-blocking file IO is not supported in the OpenVMS CRTL.<br />
##There are various known issues with symbolic link implementation.<br />
##Symbol '$' is usual for file and directory names<br />
##OpenVMS <code>chmod(0)</code> sets user's default permissions, not resets them<br />
##To delete directory user has to have ‘delete’ permission for this directory<br />
##OpenVMS creates all intermediate directories on <code>mkdir()</code><br />
#Process<br />
##There is no normal <code>fork()</code>, <code>spawn()</code> function.<br />
##Pipes are created via mailbox and have a lot of compatibility issues.<br />
##If child has threads, each thread posts 'END-OF-PIPE' when it finishes.<br />
##There is no normal <code>select()</code>, <code>poll()</code> e.t.c<br />
##<code>siginterrupt()</code> is not supported<br />
##A lot of issues with signals<br />
##Interrupting I/O operation may hang<br />
##There is no root user with zero uid<br />
##There is no unix commands like: echo, exit …<br />
##OpenVMS cannot handle recursion overflow properly - just crashes<br />
#Sockets<br />
##<code>AF_UNIX</code> has different meaning<br />
##Binding socket to empty address fails (wildcard resolved to multiple address).<br />
##<code>getpeername()</code> returns ‘0.0.0.0’ instead of error<br />
##OpenVMS crashed on <code>socket.socket.sendall</code><br />
#Time<br />
##<code>time_t</code> is unsigned<br />
##<code>strftime()</code><br />
##*Does not support %G format<br />
##*Undefined behavior when format ends with '%'<br />
##*‘%4Y’ is padded with spaces<br />
#Miscellaneous<br />
##Environment variables have unusual implementation - through logical names. There is no appropriate way to get all environment variables.<br />
##OpenVMS sqlite3 port does not support "OR ROLLBACK"<br />
##Program prints crush dump<br />
##<code>locale.strxfrm()</code> works unusual<br />
#Compiler<br />
##<code>uint_ptr</code> is always 64 bit, void* is 32 bit or 64 bit<br />
##Compiler does not support relative include paths<br />
----<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_IDE_Commands&diff=749VMS IDE Commands2019-05-07T06:12:38Z<p>Brett.cameron: </p>
<hr />
<div>To invoke the commands, press <code>F1</code> in the Visual Studio Code editor and start typing the command.<br />
[[File:Vms-ide-commands.png|800px|thumb|none|VMS IDE Commands]]<br />
<br />
=Commands=<br />
* <code>'''VMS-IDE: Terminal'''</code> - OpenVMS terminal (<code>Ctrl+F6</code>)<br />
* <code>'''VMS-IDE: Edit ssh-helper settings'''</code> - Edit connection settings<br />
* <code>'''VMS-IDE: Edit OpenVMS project settings'''</code> - Edit project settings<br />
* <code>'''VMS-IDE: Change CR/LF for all source files'''</code> - Change CRLF to LF for all source files<br />
* <code>'''VMS-IDE: Create MMS'''</code> - Create default MMS<br />
* <code>'''VMS-IDE: Build on VMS'''</code> - Build project on VMS with its dependencies<br />
* <code>'''VMS-IDE: Re-build on VMS'''</code> - Rebuild project on VMS with its dependencies<br />
* <code>'''VMS-IDE: Clean project'''</code> - Clean project, delete files from output folder<br />
* <code>'''VMS-IDE: Upload all'''</code> - Upload all new and updated files from local machine to VMS. '''NOTE''': If '''preferZip''' is set to true, the ''whole'' project will be uploaded as a ZIP file.<br />
* <code>'''VMS-IDE: Synchronize project file with VMS'''</code> - Synchronize project files with VMS<br />
* <code>'''VMS-IDE: Force synchronized status'''</code> - Force synchronized status<br />
* <code>'''VMS-IDE: Force built status'''</code> - Force built status<br />
* <code>'''VMS-IDE: Upload all via Zip'''</code> - Upload project files using Zip<br />
* <code>'''VMS-IDE: Download system headers'''</code> - Download system headers from VMS<br />
<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=Synchronize_Configuration&diff=748Synchronize Configuration2019-05-07T06:10:46Z<p>Brett.cameron: </p>
<hr />
<div>=Synchronize Configuration Example=<br />
<pre><br />
{<br />
"synchronize": {<br />
"downloadNewFiles": "edit",<br />
"keepAlive": false,<br />
"preferZip": false,<br />
"purge": false,<br />
"setTimeAttempts": 3,<br />
"setTimeByShell": true,<br />
"unzipCmd": ""<br />
}<br />
}<br />
</pre><br />
<br />
=Settings Description=<br />
* <code>'''downloadNewFiles'''</code> - Strategy for downloading remote files which are newer than local copies.<br />
** '''overwrite''' - remote files will overwrite local files.<br />
** '''skip''' - remote files will not be downloaded but an appropriate warning message will be shown.<br />
** '''edit''' - remote files will be downloaded into memory and the edit-merge window will be opened to allow the user decide what changes to save.<br />
* <code>'''keepAlive'''</code> - Shell and SFTP connections will not be closed after synchronization is done and will be reused for the next synchronization.<br />
* <code>'''preferZip'''</code> - Prefer ZIP for uploading source files.<br />
* <code>'''purge'''</code> - Execute <code>PURGE</code> command after uploading source.<br />
* <code>'''setTimeAttempts'''</code> - The maximum number of attempts to set file time. '''NOTE''': the first attempt to set file time may be rejected because the file is busy. VMS IDE will re-try to set time again. <br />
* <code>'''setTimeByShell'''</code> - If the SFTP server on the OpenVMS host did not set the file time, VMS IDE can use DCL commands to do this.<br />
* <code>'''unzipCmd'''</code> - Is used to run a user-defined command to unzip archive; default is <code>unzip -oo "-D"</code> and file name added at the end of the command.<br />
<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=SSH_Settings&diff=747SSH Settings2019-05-07T06:07:32Z<p>Brett.cameron: </p>
<hr />
<div>An SSH connection to an OpenVMS machine is required for syncing source code files, building, running and debugging projects. Depending on the type of configuration, SSH connection settings can be edited either in the ''vmssoftware.ssh-helper-settings.json'' file located in ''/.vscode'' directory or via Visual Studio Code settings page.<br />
<br />
=SSH Settings Template=<br />
<pre><br />
{<br />
"connection": {<br />
"host": "",<br />
"keyFile": "",<br />
"password": "",<br />
"port": 22,<br />
"username": ""<br />
},<br />
"host-collection": {<br />
"hosts": []<br />
},<br />
"timeouts": {<br />
"cmdTimeout": 0,<br />
"feedbackTimeout": 0,<br />
"welcomeTimeout": 0<br />
}<br />
}<br />
</pre> <br />
<br />
=Connection=<br />
The connection section sets the current connection details.<br />
* <code>'''Host'''</code> - IP-address or name of OpenVMS machine. It also can refer to the label of a connection specified in host-collection section - should be enclosed in angle brackets <code>(<hostname>)</code>. In that<br />
case, all other fields are ignored. <br />
* <code>'''Port'''</code> - The port number to use for the SSH connection. Default is 22.<br />
* <code>'''Username'''</code> - User account that will be used for the SSH connection.<br />
* <code>'''Password'''</code> - User password that will be used for the SSH connection.. If it is omitted a password input box will be shown on connection attempt.<br />
* <code>'''Key File'''</code> - Path to SSH private key file. <br />
<br />
=Host Collection=<br />
If you need to connect to different servers when working on your project, it makes sense to list all the required connections and then just pick the one that you need by using its label as the '''host''' name in the '''connection''' section.<br />
'''NOTE''': If you use VSC type of configuration, you will not be able to specify host collection in UI. Instead, you need to click "Edit in settings.json" and specify them in the '''settings.json''' file. <br />
<br />
[[File:Ssh collection hosts.png|Ssh collection hosts.png]]<br />
<br />
=Timeouts=<br />
Specifies SSH connection timesouts.<br />
* <code>'''Cmd Timeout'''</code> - Timeout for command response. If a command is sent to the OpenVMS system and the OpenVMS system does not a send response for the specified period of time, it will be considered as rejected.<br />
* <code>'''Feedback Timeout'''</code> - If the SSH connection does not send feedback for this period, the specified password will be considered as invalid.<br />
* <code>'''Welcome Timeout'''</code> - If the SSH shell prompt is not received within this period of time, the shell will be closed.<br />
<br />
'''NOTE''': Value "0" means, that timeout is not used. <br />
<br />
'''WARN''': Do not change timeout settings unless necessary.<br />
<br />
<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=Project_Settings&diff=746Project Settings2019-05-07T06:01:10Z<p>Brett.cameron: </p>
<hr />
<div>=Project Configuration Example=<br />
<pre><br />
{<br />
"project": {<br />
"break": "C",<br />
"builders": "*.{mms,com}",<br />
"exclude": "**/{node_modules,.vscode}/**",<br />
"headers": "*.h",<br />
"listing": "*.lis",<br />
"outdir": "out",<br />
"projectName": "project",<br />
"projectType": "executable",<br />
"resource": "**/resource/**",<br />
"root": "project",<br />
"source": "*.{cpp,c}"<br />
}<br />
}<br />
</pre><br />
<br />
=Settings Description=<br />
* <code>'''Break'''</code> - Keyboard key to pause debugging in VMS IDE debugger. Press <code>CTRL+Key</code> to pause debugging.<br />
* <code>'''Builders'''</code> - Mask for files used for building the project. Default is "*.{mms,com}".<br />
* <code>'''Exclude'''</code> - Folders excluded from synchronization with OpenVMS system.<br />
* <code>'''Headers'''</code> - Header files. Default is "*.{h,hpp}".<br />
* <code>'''Listing'''</code> - Listing files that will be downloaded after the project is built for debugging purpose.<br />
* <code>'''Outdir'''</code> - Output directory where object, listing and executable files will be stored when built. Is also used for temporary files. '''NOTE''': Should be only the name of the folder, not a full or relative path. <br />
* <code>'''Project Name'''</code> - Name for the executable file, auto-generated '''MMS''' file for builder, OPT file for linker, and COM file for defining logical names.<br />
* <code>'''Project Type'''</code> - Type of the project. Available types: '''executable''', '''library''' or '''shareable'''. The building method depends on the type of the project and its dependencies.<br />
* <code>'''Resource'''</code> - Files required for the project, but are not involved in the build process.<br />
* <code>'''Root'''</code> - Directory of the project on remote OpenVMS machine.<br />
* <code>'''Source'''</code> - Mask for the source files, e.g. "*.{c,cpp}".<br />
<br />
<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=SSH_Settings&diff=745SSH Settings2019-05-07T05:50:54Z<p>Brett.cameron: /* Host Collection */</p>
<hr />
<div>An SSH connection to an OpenVMS machine is required for syncing source code files, building, running and debugging projects. Depending on the type of configuration, SSH connection settings can be edited either in the ''vmssoftware.ssh-helper-settings.json'' file located in ''/.vscode'' directory or via Visual Studio Code settings page.<br />
<br />
=SSH Settings Template=<br />
<pre><br />
{<br />
"connection": {<br />
"host": "",<br />
"keyFile": "",<br />
"password": "",<br />
"port": 22,<br />
"username": ""<br />
},<br />
"host-collection": {<br />
"hosts": []<br />
},<br />
"timeouts": {<br />
"cmdTimeout": 0,<br />
"feedbackTimeout": 0,<br />
"welcomeTimeout": 0<br />
}<br />
}<br />
</pre> <br />
<br />
=Connection=<br />
Connection section sets the current connection details.<br />
* <code>'''Host'''</code> - IP-address or name of OpenVMS machine. It also can refer to the label of a connection specified in host-collection section - should be enclosed in angle brackets <code>(<hostname>)</code>. In that<br />
case, all other fields are ignored. <br />
* <code>'''Port'''</code> - The port number to use for SSH connection. Default is 22.<br />
* <code>'''Username'''</code> - User account that will be used for SSH connection.<br />
* <code>'''Password'''</code> - User password that will be used for SSH connection.. If it is omitted password input box will be shown on connection attempt.<br />
* <code>'''Key File'''</code> - Path to SSH private key file. <br />
<br />
=Host Collection=<br />
If you need to connect to different servers when working on your project, it makes sense to list all the required connections and then just pick the one that you need by using its label as the '''host''' name in the '''connection''' section.<br />
'''NOTE''': If you use VSC type of configuration, you will not be able to specify host collection in UI. Instead, you need to click "Edit in settings.json" and specify them in the '''settings.json''' file. <br />
<br />
[[File:Ssh collection hosts.png|Ssh collection hosts.png]]<br />
<br />
=Timeouts=<br />
Specifies SSH connection timesouts.<br />
* <code>'''Cmd Timeout'''</code> - Time out for command answer. If a command is sent to VMS and does not send response for the specified period of time, it will be considered as rejected.<br />
* <code>'''Feedback Timeoutt'''</code> - If SSH connection does not send feedback for this period, the specified password will be considered as invalid.<br />
* <code>'''Welcome Timeout'''</code> - If SSH shell prompt is not received for this period of time, the shell will be closed.<br />
<br />
'''NOTE''': Value "0" means, that timeout is not used. <br />
<br />
'''WARN''': Do not change timeout settings.<br />
<br />
<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=SSH_Settings&diff=744SSH Settings2019-05-07T05:49:41Z<p>Brett.cameron: </p>
<hr />
<div>An SSH connection to an OpenVMS machine is required for syncing source code files, building, running and debugging projects. Depending on the type of configuration, SSH connection settings can be edited either in the ''vmssoftware.ssh-helper-settings.json'' file located in ''/.vscode'' directory or via Visual Studio Code settings page.<br />
<br />
=SSH Settings Template=<br />
<pre><br />
{<br />
"connection": {<br />
"host": "",<br />
"keyFile": "",<br />
"password": "",<br />
"port": 22,<br />
"username": ""<br />
},<br />
"host-collection": {<br />
"hosts": []<br />
},<br />
"timeouts": {<br />
"cmdTimeout": 0,<br />
"feedbackTimeout": 0,<br />
"welcomeTimeout": 0<br />
}<br />
}<br />
</pre> <br />
<br />
=Connection=<br />
Connection section sets the current connection details.<br />
* <code>'''Host'''</code> - IP-address or name of OpenVMS machine. It also can refer to the label of a connection specified in host-collection section - should be enclosed in angle brackets <code>(<hostname>)</code>. In that<br />
case, all other fields are ignored. <br />
* <code>'''Port'''</code> - The port number to use for SSH connection. Default is 22.<br />
* <code>'''Username'''</code> - User account that will be used for SSH connection.<br />
* <code>'''Password'''</code> - User password that will be used for SSH connection.. If it is omitted password input box will be shown on connection attempt.<br />
* <code>'''Key File'''</code> - Path to SSH private key file. <br />
<br />
=Host Collection=<br />
If you need to connect to different servers when working on your project, it makes sense to list all the required connections and then just pick the one that you need by using its label as the '''host''' name in the '''connection''' section.<br />
'''NOTE''': If you use VSC type of configuration, you will not be able to specify host collection in UI. Instead, you need to click "Edit in settings.json" and specify them in the '''settings.json''' file. [[File:Ssh collection hosts.png|Ssh collection hosts.png]]<br />
<br />
=Timeouts=<br />
Specifies SSH connection timesouts.<br />
* <code>'''Cmd Timeout'''</code> - Time out for command answer. If a command is sent to VMS and does not send response for the specified period of time, it will be considered as rejected.<br />
* <code>'''Feedback Timeoutt'''</code> - If SSH connection does not send feedback for this period, the specified password will be considered as invalid.<br />
* <code>'''Welcome Timeout'''</code> - If SSH shell prompt is not received for this period of time, the shell will be closed.<br />
<br />
'''NOTE''': Value "0" means, that timeout is not used. <br />
<br />
'''WARN''': Do not change timeout settings.<br />
<br />
<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_IDE&diff=743VMS IDE2019-04-26T04:49:42Z<p>Brett.cameron: /* Restrictions */</p>
<hr />
<div>{| style="float:center;vertical-align:top;background-color:white;"<br />
| <br />
{| class="wikitable" <br />
! style="text-align:center; background-color:#067ACC;color:white;height:50px;width:550px;" | This material is under construction. The VS Code extensions are coming soon.<br />
|}<br />
|}<br />
<br />
'''VMS IDE''' is an integrated development environment that enables you to quickly and easily develop comprehensive applications for OpenVMS system. It provides a set of tools for developing, building, and debugging OpenVMS projects.<br />
<br />
=Features=<br />
[[File:Vms ide.png|800px|thumb|none|VMS IDE]]<br />
* Source code '''synchronization''' between the local machine and OpenVMS system.<br />
* '''SSH connection''' setup to the remote OpenVMS system.<br />
* '''Projects Explorer''' as a simple and convenient way to manage OpenVMS projects.<br />
* '''Debugger''' for OpenVMS projects.<br />
* '''Syntax highlighting''' for '''MMS''', '''CLD''', and '''MSG''' files.<br />
* '''Code autocompletion''' for '''MSG''' and '''CLD''' files.<br />
<br />
=Restrictions=<br />
* The '''VMS IDE''' extension can only be used in conjunction with ODS-5 OpenVMS file systems; it cannot be used with ODS-2 file systems.<br />
<br />
=Getting Started=<br />
This guide will help you install the VMS IDE extension and start working on your projects.<br />
<br />
===Quick Start===<br />
* [[VMS_IDE_Installation|Installation]]<br />
* [[VMS_IDE_Project_Configuration|Setting up a VMS Project]]<br />
* [[VMS_IDE_Developing|Working on a VMS Project]]<br />
<br />
===Commands===<br />
* [[VMS_IDE_Commands|VMS IDE Commands]]<br />
<br />
===Components===<br />
* [[VMS_IDE_Project_Explorer|Project Explorer]]<br />
* [[VMS_IDE_Debugger|Debugger]]<br />
<br />
<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_IDE&diff=742VMS IDE2019-04-26T04:49:09Z<p>Brett.cameron: </p>
<hr />
<div>{| style="float:center;vertical-align:top;background-color:white;"<br />
| <br />
{| class="wikitable" <br />
! style="text-align:center; background-color:#067ACC;color:white;height:50px;width:550px;" | This material is under construction. The VS Code extensions are coming soon.<br />
|}<br />
|}<br />
<br />
'''VMS IDE''' is an integrated development environment that enables you to quickly and easily develop comprehensive applications for OpenVMS system. It provides a set of tools for developing, building, and debugging OpenVMS projects.<br />
<br />
=Features=<br />
[[File:Vms ide.png|800px|thumb|none|VMS IDE]]<br />
* Source code '''synchronization''' between the local machine and OpenVMS system.<br />
* '''SSH connection''' setup to the remote OpenVMS system.<br />
* '''Projects Explorer''' as a simple and convenient way to manage OpenVMS projects.<br />
* '''Debugger''' for OpenVMS projects.<br />
* '''Syntax highlighting''' for '''MMS''', '''CLD''', and '''MSG''' files.<br />
* '''Code autocompletion''' for '''MSG''' and '''CLD''' files.<br />
<br />
=Restrictions=<br />
* The '''VMS IDE''' extension can only be used in conjunction with ODS-5 OpenVMS file systems; it cannot be used with ODS-2 file systems<br />
<br />
=Getting Started=<br />
This guide will help you install the VMS IDE extension and start working on your projects.<br />
<br />
===Quick Start===<br />
* [[VMS_IDE_Installation|Installation]]<br />
* [[VMS_IDE_Project_Configuration|Setting up a VMS Project]]<br />
* [[VMS_IDE_Developing|Working on a VMS Project]]<br />
<br />
===Commands===<br />
* [[VMS_IDE_Commands|VMS IDE Commands]]<br />
<br />
===Components===<br />
* [[VMS_IDE_Project_Explorer|Project Explorer]]<br />
* [[VMS_IDE_Debugger|Debugger]]<br />
<br />
<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_IDE_Project_Explorer&diff=720VMS IDE Project Explorer2019-04-16T10:51:40Z<p>Brett.cameron: </p>
<hr />
<div>The '''Project Explorer''' view helps to manage OpenVMS projects, their dependencies, and settings. It is also possible to build, rebuild, and clean the project using the '''Project Explorer''' context menu.<br />
<br />
=Description=<br />
{| style="border-style: none;"<br />
|-<br />
|rowspan="2"| [[File:Project-explorer.PNG|frame|left|Project Explorer]]<br />
|style="vertical-align:top; padding-left: 20px;" |<br />
==Project Dependencies==<br />
<br />
====Project types====<br />
* ''executable'' - executable image is created<br />
* ''library'' - object library (OLB) is created<br />
* ''shareable'' - shareable image is created<br />
<br />
====Context Menu====<br />
* '''Add to dependencies of selected''' - add the project you right-clicked to the previously selected project as a dependency<br />
* '''Remove project from dependencies''' - remove the selected project from dependencies of the main project<br />
* '''Build only this project''' - build the current project<br />
* '''Build with dependencies''' - build the current project and all its dependencies<br />
* '''Clean this only''' - clean current project only<br />
* '''Rebuild only this project''' - rebuild the current project<br />
* '''Rebuild with dependencies''' - rebuild the current project and all its dependencies<br />
<br />
====Creating MMS Files====<br />
'''VMS IDE''' can create '''MMS''' files automatically based on the project type and the types of its dependencies.<br><br />
For ''shareable'' images, an options ('''OPT''') file is created, but the universal symbol vector must be edited manually.<br><br />
If the project depends on some shareable images, a '''COM''' file is created with ''logicals'' required for running the project.<br />
<br />
==Project Description==<br />
When a project is selected in the Project Dependencies panel, its description is shown.<br />
* '''Local'''<br />
** ''folder'' - [[VMS IDE Project Configuration|Workspace folder name]]<br />
** ''buildType'' - the type of build: ''DEBUG'' or ''RELEASE'' (click to change)<br />
** ''sourceState'' - current state of source files<br />
*** ''unknown'' - no synchronization or upload was performed or there were changes to the Project or SSH settings<br />
*** ''modified'' - there are changes that need to be synchronized<br />
*** ''synchronized'' - project files on the local machine and OpenVMS are synchronized<br />
** ''buildState'' - ''built'' or ''not built''<br />
** ''masters'' - projects which depend on the currently selected project<br />
* '''SSH'''<br />
** ''host'' - OpenVMS host to synchronize and build with<br />
* '''Project'''<br />
** ''projectName'' - the name of the project<br />
** ''projectType'' - [[#Project types|the type of the project]]<br />
** ''root'' - project root on OpenVMS<br />
|}<br />
<br />
<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_IDE_Project_Explorer&diff=719VMS IDE Project Explorer2019-04-16T10:51:06Z<p>Brett.cameron: </p>
<hr />
<div>The '''Project Explorer''' view helps to manage OpenVMS projects, their dependencies, and settings. It is also possible to build, rebuild, and clean the project using the '''Project Explorer''' context menu.<br />
<br />
=Description=<br />
{| style="border-style: none;"<br />
|-<br />
|rowspan="2"| [[File:Project-explorer.PNG|frame|left|Project Explorer]]<br />
|style="vertical-align:top; padding-left: 20px;" |<br />
==Project Dependencies==<br />
<br />
====Project types====<br />
* ''executable'' - executable image is created<br />
* ''library'' - object library (OLB) is created<br />
* ''shareable'' - shareable image is created<br />
<br />
====Context Menu====<br />
* '''Add to dependencies of selected''' - add the project you right-clicked to the previously selected project as a dependency<br />
* '''Remove project from dependencies''' - remove the selected project from dependencies of the main project<br />
* '''Build only this project''' - build the current project<br />
* '''Build with dependencies''' - build the current project and all its dependencies<br />
* '''Clean this only''' - clean current project only<br />
* '''Rebuild only this project''' - rebuild the current project<br />
* '''Rebuild with dependencies''' - rebuild the current project and all its dependencies<br />
<br />
====Creating MMS Files====<br />
'''VMS IDE''' can create '''MMS''' files automatically based on the project type and the types of its dependencies.<br><br />
For ''shareable'' images, an options ('''OPT''') file is created, but the universal symbol vector must be edited manually.<br><br />
If the project depends on some shareable images, a '''COM''' file is created with ''logicals'' required for running the project.<br />
<br />
==Project Description==<br />
When a project is selected in the Project Dependencies panel, its description is shown.<br />
* '''Local'''<br />
** ''folder'' - [[VMS IDE Project Configuration|Workspace folder name]]<br />
** ''buildType'' - the type of build: ''DEBUG'' or ''RELEASE'' (click to change)<br />
** ''sourceState'' - current state of source files<br />
*** ''unknown'' - no synchronization or upload was performed or there were changes to the Project or SSH settings<br />
*** ''modified'' - there are changes that need to be synchronized<br />
*** ''synchronized'' - project files on the local machine and OpenVMS are synchronized<br />
** ''buildState'' - ''built'' or ''not built''<br />
** ''masters'' - projects which depend on the currently selected project<br />
* '''SSH'''<br />
** ''host'' - OpenVMS host to synchronize and build with<br />
* '''Project'''<br />
** ''projectName'' - the name of the project<br />
** ''projectType'' - [[#Project types|the type of the project]]<br />
** ''root'' - project root in OpenVMS<br />
|}<br />
<br />
<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_IDE_Project_Explorer&diff=718VMS IDE Project Explorer2019-04-16T10:47:53Z<p>Brett.cameron: /* Creating MMS */</p>
<hr />
<div>The '''Project Explorer''' view helps to manage OpenVMS projects, their dependencies, and settings. It is also possible to build, rebuild, and clean the project using the '''Project Explorer''' context menu.<br />
<br />
=Description=<br />
{| style="border-style: none;"<br />
|-<br />
|rowspan="2"| [[File:Project-explorer.PNG|frame|left|Project Explorer]]<br />
|style="vertical-align:top; padding-left: 20px;" |<br />
==Project Dependencies==<br />
<br />
====Project types====<br />
* ''executable'' - executable image is created<br />
* ''library'' - object library (OLB) is created<br />
* ''shareable'' - shareable image is created<br />
<br />
====Context Menu====<br />
* '''Add to dependencies of selected''' - add the project you right-clicked to the previously selected project as a dependency<br />
* '''Remove project from dependencies''' - remove the selected project from dependencies of the main project<br />
* '''Build only this project''' - build the current project<br />
* '''Build with dependencies''' - build the current project and all its dependencies<br />
* '''Clean this only''' - clean current project only<br />
* '''Rebuild only this project''' - rebuild the current project<br />
* '''Rebuild with dependencies''' - rebuild the current project and all its dependencies<br />
<br />
====Creating MMS Files====<br />
'''VMS IDE''' can create '''MMS''' files automatically based on the project type and the types of its dependencies.<br><br />
For ''shareable'' images, an options ('''OPT''') file is created, but the universal symbol vector must be edited manually.<br><br />
If the project depends on some shareable images, a '''COM''' file is created with ''logicals'' required for running the project.<br />
<br />
==Project Description==<br />
When a project is selected in the Project Dependencies panel, its description is shown.<br />
* '''Local'''<br />
** ''folder'' - [[VMS IDE Project Configuration|Workspace folder name]]<br />
** ''buildType'' - the type of build: ''DEBUG'' or ''RELEASE'' (click to change)<br />
** ''sourceState'' - current state of source files<br />
*** ''unknown'' - no synchronization or upload was performed or there were changes to the Project or SSH settings<br />
*** ''modified'' - there are changes that needs to be synchronized<br />
*** ''synchronized'' - project files on the local machine and OpenVMS are synchronized<br />
** ''buildState'' - ''built'' or ''not built''<br />
** ''masters'' - projects which depend on the currently selected project<br />
* '''SSH'''<br />
** ''host'' - OpenVMS host to synchronize and build with<br />
* '''Project'''<br />
** ''projectName'' - the name of the project<br />
** ''projectType'' - [[#Project types|the type of the project]]<br />
** ''root'' - project root in OpenVMS<br />
|}<br />
<br />
<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_IDE_Developing&diff=717VMS IDE Developing2019-04-16T10:04:56Z<p>Brett.cameron: </p>
<hr />
<div>==Loading Existing Project== <br />
If you start working on an existing project that resides on your OpenVMS machine, you need to download the source files to your local machine. Use the '''Synchronizer''' tool as described below to download the source files.<br />
# Change the [[Synchronize Configuration#Settings Description|'''downloadNewFiles''']] option to ''overwrite''.<br />
# Run the <code>VMS-IDE: Synchronize project files with VMS</code> command.<br />
# After all project files are downloaded, change the '''downloadNewFiles''' option to ''skip'' or ''edit'' to prevent silent overwriting of local files.<br />
<br />
==Managing Project Source Files==<br />
You can view and edit all project files from the Visual Studio Code '''Explorer'''. Refer to Visual Studio Code [https://code.visualstudio.com/docs/getstarted/userinterface documentation] to learn more about '''Explorer''' view features.<br />
<br />
The OpenVMS project structure may look like shown below:<br />
[[File:Vms ide explorer.png|200px|thumb|none|VMS IDE Explorer]]<br />
<br />
==Managing the Project==<br />
You can manage your OpenVMS project from the [[VMS_IDE_Project_Explorer|'''Project Explorer''']] view. To open the view, click ''Project Explorer'' icon on the Activity Bar.<br />
<br />
===Managing Dependencies===<br />
If you work on a complex project and you need to add dependencies, use the '''PROJET DEPENDENCIES''' section. <br><br />
Assuming that you want to add "Project B" to "Project A" dependencies, <br><br />
# Select "Project A" in the '''PROJET DEPENDENCIES''' panel.<br />
# Right-click "Project B", and select ''Add to dependencies of selected'' item from the context menu.<br />
<br><br />
To remove a project from dependencies<br />
# Open the '''PROJET DEPENDENCIES''' section.<br />
# Right-click the project, then select ''Remove from dependencies''.<br />
<br />
=Building=<br />
<br />
===Build MMS===<br />
Before building the project, create the '''MMS''' file by pressing <code>F1</code> and running <code>VMS-IDE: Create MMS</code>.<br />
<br />
===Building VMS Project===<br />
To build a project in VMS IDE: <br />
# Open the [[VMS_IDE_Project_Explorer|'''Project Explorer''']] view.<br />
# Select the project you want to build in the '''PROJET DEPENDENCIES''' section.<br />
# In the '''PROJET DESCRIPTION''' section, select the required build type (<code>DEBUG</code> or <code>RELEASE</code>) by clicking the '''buildType''' parameter.<br />
# Right-click the project and select ''Build with dependencies'' from the context menu.<br />
<br />
If there are any changes to the project, the updated files will be uploaded to the OpenVMS system. Previously created object and listing files (.OBJ, .LIS) will be removed from the OpenVMS system. This guarantees that up-to-date files are uploaded to the OpenVMS system.<br />
<br />
'''NOTE''': you can manually upload all new and updated files by using the [[VMS_IDE_Commands|'''VMS-IDE: Upload all''']] command.<br />
<br />
===Building with Custom Procedure===<br />
To build a project using a custom build procedure, edit the ''task.json'' file <br />
<pre>{<br />
"type": "task2cmd",<br />
"command": "vmssoftware.synchronizer.buildProject",<br />
"extension": "vmssoftware.synchronizer",<br />
"parameter": "build.com",<br />
"label": "Build Procedure",<br />
"problemMatcher": []<br />
}</pre><br />
where:<br />
* '''parameter''' is the name of your build procedure (COM file)<br />
* '''label''' meaningful task name<br />
All other parameters must be as shown in example.<br />
<br />
'''NOTE''': see Visual Studio Code [https://code.visualstudio.com/docs/editor/tasks documentation] for more information on '''tasks'''.<br />
<br />
=Debugging=<br />
Use [[VMS_IDE_Debugger|'''Debugger''']] view to debug OpenVMS projects.<br />
<br />
'''NOTE''': Before running the debugger, make sure that you have actual DEBUG builds on the OpenVMS system.<br />
<br />
To start a debugging session, press <code>F5</code>. If there is no "launch.json" file in the project directory, you will be asked to select the environment. Select <code>VMS Debugger</code> from the popup list.<br />
The '''launch.json''' file will be created and filled with the required information. There are two types of launch configuration - '''DEBUG''' and '''RUN'''.<br />
<pre>"configurations": [<br />
{<br />
"type": "vms_dbg",<br />
"request": "launch",<br />
"name": "Debug",<br />
"program": "",<br />
"arguments": "",<br />
"stopOnEntry": true,<br />
"typeRun": "DEBUG"<br />
}<br />
]<br />
</pre><br />
For the '''program''' field, specify the relative path to the executable, for example <code>[.project.bin.release]hello.exe</code>. <br />
If the field is empty, '''VMS IDE''' will try to fill it with data from the project settings.<br />
<br />
To choose which configuration to use, go to "Debug" (<code>Ctrl-Shift-D</code>) and select the appropriate configuration from the drop-down list.<br />
Press <code>F5</code> again to run debugger.<br />
<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_IDE_Developing&diff=716VMS IDE Developing2019-04-16T10:03:25Z<p>Brett.cameron: </p>
<hr />
<div>==Loading Existing Project== <br />
If you start working on an existing project that resides on your OpenVMS machine, you need to download the source files to your local machine. Use the '''Synchronizer''' tool as described below to download the source files.<br />
# Change the [[Synchronize Configuration#Settings Description|'''downloadNewFiles''']] option to ''overwrite''.<br />
# Run the <code>VMS-IDE: Synchronize project files with VMS</code> command.<br />
# After all project files are downloaded, change the '''downloadNewFiles''' option to ''skip'' or ''edit'' to prevent silent overwriting of local files.<br />
<br />
==Managing Project Source Files==<br />
You can view and edit all project files from the Visual Studio Code '''Explorer'''. Refer to Visual Studio Code [https://code.visualstudio.com/docs/getstarted/userinterface documentation] to learn more about '''Explorer''' view features.<br />
<br />
The OpenVMS project structure may look like shown below:<br />
[[File:Vms ide explorer.png|200px|thumb|none|VMS IDE Explorer]]<br />
<br />
==Managing the Project==<br />
You can manage your OpenVMS project from the [[VMS_IDE_Project_Explorer|'''Project Explorer''']] view. To open the view, click ''Project Explorer'' icon on the Activity Bar.<br />
<br />
===Managing Dependencies===<br />
If you work on a complex project and you need to add dependencies, use the '''PROJET DEPENDENCIES''' section. <br><br />
Assuming that you want to add "Project B" to "Project A" dependencies, <br><br />
# Select "Project A" in the '''PROJET DEPENDENCIES''' panel.<br />
# Right-click "Project B", and select ''Add to dependencies of selected'' item from the context menu.<br />
<br><br />
To remove a project from dependencies<br />
# Open the '''PROJET DEPENDENCIES''' section.<br />
# Right-click the project, then select ''Remove from dependencies''.<br />
<br />
=Building=<br />
<br />
===Build MMS===<br />
Before building the project, create the '''MMS''' file by pressing <code>F1</code> and running <code>VMS-IDE: Create MMS</code>.<br />
<br />
===Building VMS Project===<br />
To build a project in VMS IDE: <br />
# Open the [[VMS_IDE_Project_Explorer|'''Project Explorer''']] view.<br />
# Select the project you want to build in the '''PROJET DEPENDENCIES''' section.<br />
# In the '''PROJET DESCRIPTION''' section, select the required build type (<code>DEBUG</code> or <code>RELEASE</code>) by clicking the '''buildType''' parameter.<br />
# Right-click the project and select ''Build with dependencies'' from the context menu.<br />
<br />
If there are any changes to the project, the updated files will be uploaded to the OpenVMS system. Previously created object and listing files (.OBJ, .LIS) will be removed from the OpenVMS system. This guarantees that up-to-date files are uploaded to the OpenVMS system.<br />
<br />
'''NOTE''': you can manually upload all new and updated files by using the [[VMS_IDE_Commands|'''VMS-IDE: Upload all''']] command.<br />
<br />
===Building with Custom Procedure===<br />
To build a project using a custom build procedure, edit the ''task.json'' file <br />
<pre>{<br />
"type": "task2cmd",<br />
"command": "vmssoftware.synchronizer.buildProject",<br />
"extension": "vmssoftware.synchronizer",<br />
"parameter": "build.com",<br />
"label": "Build Procedure",<br />
"problemMatcher": []<br />
}</pre><br />
where:<br />
* '''parameter''' is the name of your build procedure (COM file)<br />
* '''label''' meaningful task name<br />
All other parameters must be as shown in example.<br />
<br />
'''NOTE''': see Visual Studio Code [https://code.visualstudio.com/docs/editor/tasks documentation] for more information on '''tasks'''.<br />
<br />
=Debugging=<br />
Use [[VMS_IDE_Debugger|'''Debugger''']] view to debug OpenVMS projects.<br />
<br />
'''NOTE''': Before running the debugger, make sure that you have actual DEBUG builds on the OpenVMS system.<br />
<br />
To start debugging session, press <code>F5</code>. If there is no "launch.json" file in the project directory, you will be asked to select the environment. Select <code>VMS Debugger</code> from the popup list.<br />
The '''launch.json''' file will be created and filled with the required information. There are two types of launch configuration - '''DEBUG''' and '''RUN'''.<br />
<pre>"configurations": [<br />
{<br />
"type": "vms_dbg",<br />
"request": "launch",<br />
"name": "Debug",<br />
"program": "",<br />
"arguments": "",<br />
"stopOnEntry": true,<br />
"typeRun": "DEBUG"<br />
}<br />
]<br />
</pre><br />
For the '''program''' field, specify the relative path to the executable, for example <code>[.project.bin.release]hello.exe</code>. <br />
If the field is empty, '''VMS IDE''' will try to fill it with data from the project settings.<br />
<br />
To choose which configuration to use, go to "Debug" (<code>Ctrl-Shift-D</code>) and select the appropriate configuration from the drop-down list.<br />
Press <code>F5</code> again to run debugger.<br />
<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_IDE_Developing&diff=715VMS IDE Developing2019-04-16T10:01:42Z<p>Brett.cameron: </p>
<hr />
<div>==Loading Existing Project== <br />
If you start working on an existing project that resides on your OpenVMS machine, you need to download the source files to your local machine. Use the '''Synchronizer''' tool as described below to download the source files.<br />
# Change the [[Synchronize Configuration#Settings Description|'''downloadNewFiles''']] option to ''overwrite''.<br />
# Run the <code>VMS-IDE: Synchronize project files with VMS</code> command.<br />
# After all project files are downloaded, change the '''downloadNewFiles''' option to ''skip'' or ''edit'' to prevent silent overwriting of local files.<br />
<br />
==Managing Project Source Files==<br />
You can view and edit all project files from the Visual Studio Code '''Explorer'''. Refer to Visual Studio Code [https://code.visualstudio.com/docs/getstarted/userinterface documentation] to learn more about '''Explorer''' view features.<br />
<br />
The OpenVMS project structure may look like shown below:<br />
[[File:Vms ide explorer.png|200px|thumb|none|VMS IDE Explorer]]<br />
<br />
==Managing the Project==<br />
You can manage your OpenVMS project from the [[VMS_IDE_Project_Explorer|'''Project Explorer''']] view. To open the view, click ''Project Explorer'' icon on the Activity Bar.<br />
<br />
===Managing Dependencies===<br />
If you work on a complex project and you need to add dependencies, use the '''PROJET DEPENDENCIES''' section. <br><br />
Assuming that you want to add "Project B" to "Project A" dependencies, <br><br />
# Select "Project A" in the '''PROJET DEPENDENCIES''' panel.<br />
# Right-click "Project B", and select ''Add to dependencies of selected'' item from the context menu.<br />
<br><br />
To remove a project from dependencies<br />
# Open the '''PROJET DEPENDENCIES''' section.<br />
# Right-click the project, then select ''Remove from dependencies''.<br />
<br />
=Building=<br />
<br />
===Build MMS===<br />
Before building the project, create the '''MMS''' file by pressing <code>F1</code> and running <code>VMS-IDE: Create MMS</code>.<br />
<br />
===Building VMS Project===<br />
To build a project in VMS IDE: <br />
# Open the [[VMS_IDE_Project_Explorer|'''Project Explorer''']] view.<br />
# Select the project you want to build in the '''PROJET DEPENDENCIES''' section.<br />
# In the '''PROJET DESCRIPTION''' section, select the required build type (<code>DEBUG</code> or <code>RELEASE</code>) by clicking the '''buildType''' parameter.<br />
# Right-click the project and select ''Build with dependencies'' from the context menu.<br />
<br />
If there are any changes to the project, the updated files will be uploaded to the OpenVMS system. Previously created object and listing files (.OBJ, .LIS) will be removed from the OpenVMS system. This guarantees that up-to-date files are uploaded to the OpenVMS system.<br />
<br />
'''NOTE''': you can manually upload all new and updated files by using the [[VMS_IDE_Commands|'''VMS-IDE: Upload all''']] command.<br />
<br />
===Building with Custom Procedure===<br />
To build a project using a custom build procedure, edit the ''task.json'' file <br />
<pre>{<br />
"type": "task2cmd",<br />
"command": "vmssoftware.synchronizer.buildProject",<br />
"extension": "vmssoftware.synchronizer",<br />
"parameter": "build.com",<br />
"label": "Build Procedure",<br />
"problemMatcher": []<br />
}</pre><br />
where<br />
* '''parameter''' is the name of your build procedure (COM file)<br />
* '''label''' meaningful task name<br />
All other parameters must be as shown in example.<br />
<br />
'''NOTE''': see Visual Studio Code [https://code.visualstudio.com/docs/editor/tasks documentation] for more information on '''tasks'''.<br />
<br />
=Debugging=<br />
Use [[VMS_IDE_Debugger|'''Debugger''']] view to debug OpenVMS projects.<br />
<br />
'''NOTE''': Before running debugger, make sure that you have actual DEBUG builds on the OpenVMS system.<br />
<br />
To start debugging session, press <code>F5</code>. If there is no "launch.json" file in the project directory, you will be asked to select the environment. Select <code>VMS Debugger</code> from the popup list.<br />
The '''launch.json''' file will be created and filled with the required information. There are two types of launch configuration - '''DEBUG''' and '''RUN'''.<br />
<pre>"configurations": [<br />
{<br />
"type": "vms_dbg",<br />
"request": "launch",<br />
"name": "Debug",<br />
"program": "",<br />
"arguments": "",<br />
"stopOnEntry": true,<br />
"typeRun": "DEBUG"<br />
}<br />
]<br />
</pre><br />
For the '''program''' field, specify the relative path to the executable, for example <code>[.project.bin.release]hello.exe</code>. <br />
If the field is empty, '''VMS IDE''' will try to fill it with data from the project settings.<br />
<br />
To choose which configuration to use, go to "Debug" (<code>Ctrl-Shift-D</code>) and select the appropriate configuration from the drop-down list.<br />
Press <code>F5</code> again to run debugger.<br />
<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_IDE_Developing&diff=714VMS IDE Developing2019-04-16T09:59:38Z<p>Brett.cameron: </p>
<hr />
<div>==Loading Existing Project== <br />
If you start working on an existing project that resides on your OpenVMS machine, you need to download the source files to your local machine. Use the '''Synchronizer''' tool as described below to download the source files.<br />
# Change the [[Synchronize Configuration#Settings Description|'''downloadNewFiles''']] option to ''overwrite''.<br />
# Run the <code>VMS-IDE: Synchronize project files with VMS</code> command.<br />
# After all project files are downloaded, change the '''downloadNewFiles''' option to ''skip'' or ''edit'' to prevent silent overwriting of local files.<br />
<br />
==Managing Project Source Files==<br />
You can view and edit all project files from the Visual Studio Code '''Explorer'''. Refer to Visual Studio Code [https://code.visualstudio.com/docs/getstarted/userinterface documentation] to learn more about '''Explorer''' view features.<br />
<br />
The OpenVMS project structure may look like shown below:<br />
[[File:Vms ide explorer.png|200px|thumb|none|VMS IDE Explorer]]<br />
<br />
==Managing the Project==<br />
You can manage your OpenVMS project from the [[VMS_IDE_Project_Explorer|'''Project Explorer''']] view. To open the view, click ''Project Explorer'' icon on the Activity Bar.<br />
<br />
===Managing Dependencies===<br />
If you work on a complex project and you need to add dependencies, use the '''PROJET DEPENDENCIES''' section. <br><br />
Assuming that you want to add "Project B" to "Project A" dependencies, <br><br />
# Select "Project A" in the '''PROJET DEPENDENCIES''' panel.<br />
# Right-click "Project B", and select ''Add to dependencies of selected'' item from the context menu.<br />
<br><br />
To remove a project from dependencies<br />
# Open the '''PROJET DEPENDENCIES''' section.<br />
# Right-click the project, then select ''Remove from dependencies''.<br />
<br />
=Building=<br />
<br />
===Build MMS===<br />
Before building the project, create the '''MMS''' file by pressing <code>F1</code> and running <code>VMS-IDE: Create MMS</code>.<br />
<br />
===Building VMS Project===<br />
To build a project in VMS IDE: <br />
# Open the [[VMS_IDE_Project_Explorer|'''Project Explorer''']] view.<br />
# Select the project you want to build in the '''PROJET DEPENDENCIES''' section.<br />
# In the '''PROJET DESCRIPTION''' section, select the required build type (<code>DEBUG</code> or <code>RELEASE</code>) by clicking the '''buildType''' parameter.<br />
# Right-click the project and select ''Build with dependencies'' from the context menu.<br />
<br />
If there are any changes to the project, the updated files will be uploaded to the OpenVMS system. Previously created object and listing files (.OBJ, .LIS) will be removed from the OpenVMS system. This guarantees that up-to-date files are uploaded to the OpenVMS system.<br />
<br />
'''NOTE''': you can manually upload all new and updated file by using [[VMS_IDE_Commands|'''VMS-IDE: Upload all''']] command.<br />
<br />
===Building with Custom Procedure===<br />
To build a project using a custom build procedure, edit the ''task.json'' file <br />
<pre>{<br />
"type": "task2cmd",<br />
"command": "vmssoftware.synchronizer.buildProject",<br />
"extension": "vmssoftware.synchronizer",<br />
"parameter": "build.com",<br />
"label": "Build Procedure",<br />
"problemMatcher": []<br />
}</pre><br />
where<br />
* '''parameter''' is the name of your build procedure (COM file)<br />
* '''label''' meaningful task name<br />
All other parameters must be as shown in example.<br />
<br />
'''NOTE''': see Visual Studio Code [https://code.visualstudio.com/docs/editor/tasks documentation] for more information on '''tasks'''.<br />
<br />
=Debugging=<br />
Use [[VMS_IDE_Debugger|'''Debugger''']] view to debug OpenVMS projects.<br />
<br />
'''NOTE''': Before running debugger, make sure that you have actual DEBUG builds on the OpenVMS system.<br />
<br />
To start debugging session, press <code>F5</code>. If there is no "launch.json" file in the project directory, you will be asked to select the environment. Select <code>VMS Debugger</code> from the popup list.<br />
The '''launch.json''' file will be created and filled with the required information. There are two types of launch configuration - '''DEBUG''' and '''RUN'''.<br />
<pre>"configurations": [<br />
{<br />
"type": "vms_dbg",<br />
"request": "launch",<br />
"name": "Debug",<br />
"program": "",<br />
"arguments": "",<br />
"stopOnEntry": true,<br />
"typeRun": "DEBUG"<br />
}<br />
]<br />
</pre><br />
For the '''program''' field, specify the relative path to the executable, for example <code>[.project.bin.release]hello.exe</code>. <br />
If the field is empty, '''VMS IDE''' will try to fill it with data from the project settings.<br />
<br />
To choose which configuration to use, go to "Debug" (<code>Ctrl-Shift-D</code>) and select the appropriate configuration from the drop-down list.<br />
Press <code>F5</code> again to run debugger.<br />
<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_IDE_Developing&diff=713VMS IDE Developing2019-04-16T09:56:41Z<p>Brett.cameron: </p>
<hr />
<div>==Loading Existing Project== <br />
If you start working on an existing project that resides on your OpenVMS machine, you need to download the source files to your local machine. Use the '''Synchronizer''' tool as described below to download the source files.<br />
# Change the [[Synchronize Configuration#Settings Description|'''downloadNewFiles''']] option to ''overwrite''.<br />
# Run the <code>VMS-IDE: Synchronize project files with VMS</code> command.<br />
# After all project files are downloaded, change the '''downloadNewFiles''' option to ''skip'' or ''edit'' to prevent silent overwriting of local files.<br />
<br />
==Managing Project Source Files==<br />
You can view and edit all project files from the Visual Studio Code '''Explorer'''. Refer to Visual Studio Code [https://code.visualstudio.com/docs/getstarted/userinterface documentation] to learn more about '''Explorer''' view features.<br />
<br />
The OpenVMS project structure may look like shown below:<br />
[[File:Vms ide explorer.png|200px|thumb|none|VMS IDE Explorer]]<br />
<br />
==Managing the Project==<br />
You can manage your OpenVMS project from the [[VMS_IDE_Project_Explorer|'''Project Explorer''']] view. To open the view, click ''Project Explorer'' icon on the Activity Bar.<br />
<br />
===Managing Dependencies===<br />
If you work on a complex project and you need to add dependencies, use the '''PROJET DEPENDENCIES''' section. <br><br />
Assuming that you want to add "Project B" to "Project A" dependencies, <br><br />
# Select "Project A" in the '''PROJET DEPENDENCIES''' panel.<br />
# Right-click "Project B", and select ''Add to dependencies of selected'' item from the context menu.<br />
<br><br />
To remove a project from dependencies<br />
# Open the '''PROJET DEPENDENCIES''' section.<br />
# Right-click the project, then select ''Remove from dependencies''.<br />
<br />
=Building=<br />
<br />
===Build MMS===<br />
Before building the project, create the '''MMS''' file by pressing <code>F1</code> and running <code>VMS-IDE: Create MMS</code>.<br />
<br />
===Building VMS Project===<br />
To build a project in VMS IDE: <br />
# Open the [[VMS_IDE_Project_Explorer|'''Project Explorer''']] view.<br />
# Select the project you want to build in the '''PROJET DEPENDENCIES''' section.<br />
# In the '''PROJET DESCRIPTION''' section, select the required build type (<code>DEBUG</code> or <code>RELEASE</code>) by clicking the '''buildType''' parameter.<br />
# Right-click the project and select ''Build with dependencies'' from the context menu.<br />
<br />
If there are any changes to the project, the updated files will be uploaded to the OpenVMS system. Previously created object and listing files (.OBJ, .LTS) will be removed from the OpenVMS system. This guarantees that up-to-date files are uploaded to the OpenVMS system.<br />
<br />
'''NOTE''': you can manually upload all new and updated file by using [[VMS_IDE_Commands|'''VMS-IDE: Upload all''']] command.<br />
<br />
===Building with Custom Procedure===<br />
To build a project using a custom build procedure, edit the ''task.json'' file <br />
<pre>{<br />
"type": "task2cmd",<br />
"command": "vmssoftware.synchronizer.buildProject",<br />
"extension": "vmssoftware.synchronizer",<br />
"parameter": "build.com",<br />
"label": "Build Procedure",<br />
"problemMatcher": []<br />
}</pre><br />
where<br />
* '''parameter''' is the name of your build procedure (COM file)<br />
* '''label''' meaningful task name<br />
All other parameters must be as shown in example.<br />
<br />
'''NOTE''': see Visual Studio Code [https://code.visualstudio.com/docs/editor/tasks documentation] for more information on '''tasks'''.<br />
<br />
=Debugging=<br />
Use [[VMS_IDE_Debugger|'''Debugger''']] view to debug OpenVMS projects.<br />
<br />
'''NOTE''': Before running debugger, make sure that you have actual DEBUG builds on the OpenVMS system.<br />
<br />
To start debugging session, press <code>F5</code>. If there is no "launch.json" file in the project directory, you will be asked to select the environment. Select <code>VMS Debugger</code> from the popup list.<br />
The '''launch.json''' file will be created and filled with the required information. There are two types of launch configuration - '''DEBUG''' and '''RUN'''.<br />
<pre>"configurations": [<br />
{<br />
"type": "vms_dbg",<br />
"request": "launch",<br />
"name": "Debug",<br />
"program": "",<br />
"arguments": "",<br />
"stopOnEntry": true,<br />
"typeRun": "DEBUG"<br />
}<br />
]<br />
</pre><br />
For the '''program''' field, specify the relative path to the executable, for example <code>[.project.bin.release]hello.exe</code>. <br />
If the field is empty, '''VMS IDE''' will try to fill it with data from the project settings.<br />
<br />
To choose which configuration to use, go to "Debug" (<code>Ctrl-Shift-D</code>) and select the appropriate configuration from the drop-down list.<br />
Press <code>F5</code> again to run debugger.<br />
<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_IDE_Project_Configuration&diff=712VMS IDE Project Configuration2019-04-16T09:53:43Z<p>Brett.cameron: </p>
<hr />
<div>=Workspace=<br />
When starting working on an OpenVMS project in the '''VMS IDE''', you need to configure your workspace, set project folders, and select the type of configuration that will be used.<br />
<br />
==Project folder==<br />
Use '''Explorer''' view to manage source code, resources, and settings files for your projects.<br />
{| style="border-style: none;"<br />
|-<br />
|rowspan="2"| [[File:Vms ide explorer.png|200px|thumb|none|VMS IDE Explorer]]<br />
|style="vertical-align:top; padding-left: 20px;" | The project folder will store project settings and source files. To add a project folder<br />
# Create a folder on your local machine. <br />
# In Visual Studio Code, click the ''Explorer'' icon (<code>Ctrl+Shift+E</code>) in the Activity Bar<br />
# Click ''Open Folder'' and select the previously created folder.<br />
<br><br />
If you are working on a complex project with dependencies, you will likely need to add other projects to the current workspace.<br><br />
For this, just add another project folder as shown below.<br />
# Create another folder that will store files of the second project<br />
# In Visual Studio Code, select ''File > Add folder to workspace'' and select the folder you created.<br />
|}<br />
<br />
==End of line==<br />
Specify the End of Line character that will be used across all source files. '''You must use <code>LF</code>'''.<br />
# Open Visual Studio Code settings (<code>Ctrl+,</code>)<br />
# Navigate to ''Text Editor > Files > Eol'' (the default end of line character) and set it to ''\n''. <br />
<br />
==Type of configuration==<br />
Select the type of configuration for your project. The recommended type is '''FS'''.<br />
# Open Visual Studio Code settings (<code>Ctrl+,</code>)<br />
# Navigate to ''Extensions > VMS-IDE > Config-helper › Settings: Using'', and select one of the options:<br />
#* '''FS''' - save settings in local JSON files.<br />
#* '''VFS''' - save setting in VS Code virtual file system.<br />
#* '''VCS''' - manage settings using VS Code provided API.<br />
# Press <code>F1</code> and run the ''Reload window'' command or close Visual Studio Code and open it again.<br />
<br />
{| style="border-style: none;"<br />
! FS and VFS <br />
! VCS<br />
|-<br />
|style="padding-right: 20px;" | [[File:Syncronizer-settings-fs.png|600px|none|thumb|]]<br />
|style="padding-left: 20px;" | [[File:Syncronizer-settings-vsc.png|600px|thumb|none|]]<br />
|-<br />
|style="padding-right: 20px; text-align: center" | Settings are stored in a JSON file that can be easily modified in the editor.<br />
|style="padding-left: 20px; text-align: center" | Settings can be adjusted using Visual Studio Code settings page.<br />
|}<br />
<br />
'''NOTE''': Changing the type of configuration does not copy existing settings from one location to another.<br />
<br />
=SSH Configuration=<br />
The SSH connection to an OpenVMS machine is required for syncing source files, building, and debugging projects. There are two ways of managing SSH connection settings.<br />
<br />
; Command : Press <code>F1</code> and run the <code>VMS-IDE: Edit ssh-helper settings</code> command.<br />
<br />
; Project Explorer : <br />
:# Open [[VMS_IDE_Project_Explorer|'''Project Explorer''']]<br />
:# Select your project from the list<br />
:# In the ''PROJECT DESCRIPTION'' section, right-click ''SSH > host'' and select ''Edit''.<br />
<br />
==SSH Settings description==<br />
See [[SSH_Settings|''SSH settings'']] for more details.<br />
<br />
=Project Configuration=<br />
To open the project settings, press <code>F1</code> and run the <code>VMS-IDE: Edit OpenVMS project settings</code> command or use [[VMS_IDE_Project_Explorer|'''Project Explorer''']] view.<br />
<br />
==Adjusting Settings==<br />
The project configuration procedure varies depending on the selected type of configuration.<br />
<br />
; FS or VFS : The Edit command loads current settings from memory and saves them to '''vmssoftware.synchronizer-settings.json''', then opens the file for editing.<br />
; VCS : The Edit command opens Workspace settings. Navigate to '''Synchronizer''' section and adjust the settings.<br />
<br />
==Settings description==<br />
The settings are split into two sections:<br />
* [[Project_Settings|''Project'']] - general project settings <br />
* [[Synchronize_Configuration|''Synchronize'']] - synchronizer specific settings<br />
<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_IDE_Project_Configuration&diff=711VMS IDE Project Configuration2019-04-16T09:50:59Z<p>Brett.cameron: </p>
<hr />
<div>=Workspace=<br />
When starting working on an OpenVMS project in the '''VMS IDE''', you need to configure your workspace, set project folders, and select the type of configuration that will be used.<br />
<br />
==Project folder==<br />
Use '''Explorer''' view to manage source code, resources, and settings files for your projects.<br />
{| style="border-style: none;"<br />
|-<br />
|rowspan="2"| [[File:Vms ide explorer.png|200px|thumb|none|VMS IDE Explorer]]<br />
|style="vertical-align:top; padding-left: 20px;" | The project folder will store project settings and source files. To add a project folder<br />
# Create a folder on your local machine. <br />
# In Visual Studio Code, click the ''Explorer'' icon (<code>Ctrl+Shift+E</code>) in the Activity Bar<br />
# Click ''Open Folder'' and select the previously created folder.<br />
<br><br />
If you are working on a complex project with dependencies, you will likely need to add other projects to the current workspace.<br><br />
For this, just add another project folder as shown below.<br />
# Create another folder that will store files of the second project<br />
# In Visual Studio Code, select ''File > Add folder to workspace'' and select the folder you created.<br />
|}<br />
<br />
==End of line==<br />
Specify the End of Line character that will be used across all source files. '''You must use <code>LF</code>'''.<br />
# Open Visual Studio Code settings (<code>Ctrl+,</code>)<br />
# Navigate to ''Text Editor > Files > Eol'' (the default end of line character) and set it to ''\n''. <br />
<br />
==Type of configuration==<br />
Select the type of configuration for your project. The recommended type is '''FS'''.<br />
# Open Visual Studio Code settings (<code>Ctrl+,</code>)<br />
# Navigate to ''Extensions > VMS-IDE > Config-helper › Settings: Using'', and select one of the options:<br />
#* '''FS''' - save settings in local JSON files.<br />
#* '''VFS''' - save setting in VS Code virtual file system.<br />
#* '''VCS''' - manage settings using VS Code provided API.<br />
# Press <code>F1</code> and run the ''Reload window'' command or close Visual Studio Code and open it again.<br />
<br />
{| style="border-style: none;"<br />
! FS and VFS <br />
! VCS<br />
|-<br />
|style="padding-right: 20px;" | [[File:Syncronizer-settings-fs.png|600px|none|thumb|]]<br />
|style="padding-left: 20px;" | [[File:Syncronizer-settings-vsc.png|600px|thumb|none|]]<br />
|-<br />
|style="padding-right: 20px; text-align: center" | Settings are stored in a JSON file that can be easily modified in the editor.<br />
|style="padding-left: 20px; text-align: center" | Settings can be adjusted using Visual Studio Code settings page.<br />
|}<br />
<br />
'''NOTE''': Changing the type of configuration does not copy existing settings from one location to another.<br />
<br />
=SSH Configuration=<br />
The SSH connection to an OpenVMS machine is required for syncing source files, building, and debugging projects. There are two ways of managing SSH connection settings.<br />
<br />
; Command : Press <code>F1</code> and run the <code>VMS-IDE: Edit ssh-helper settings</code> command.<br />
<br />
; Project Explorer : <br />
:# Open [[VMS_IDE_Project_Explorer|'''Project Explorer''']]<br />
:# Select your project from the list<br />
:# In the ''PROJECT DESCRIPTION'' section, right-click ''SSH > host'' and select ''Edit''.<br />
<br />
==SSH Settings description==<br />
See [[SSH_Settings|''SSH settings'']] for more details.<br />
<br />
=Project Configuration=<br />
To open the project settings, press <code>F1</code> and run <code>VMS-IDE: Edit OpenVMS project settings</code> command or use [[VMS_IDE_Project_Explorer|'''Project Explorer''']] view.<br />
<br />
==Adjusting Settings==<br />
The project configuration procedure varies depending on the selected type of configuration.<br />
<br />
; FS or VFS : The Edit command loads current settings from memory and saves it to '''vmssoftware.synchronizer-settings.json''' file, then opens the file for editing.<br />
; VCS : The Edit command opens Workspace settings. Navigate to '''Synchronizer''' section and adjust the settings.<br />
<br />
==Settings description==<br />
The settings are split into two sections:<br />
* [[Project_Settings|''Project'']] - general project settings <br />
* [[Synchronize_Configuration|''Synchronize'']] - synchronizer specific settings<br />
<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_IDE_Project_Configuration&diff=710VMS IDE Project Configuration2019-04-16T09:48:47Z<p>Brett.cameron: </p>
<hr />
<div>=Workspace=<br />
When starting working on an OpenVMS project in the '''VMS IDE''', you need to configure your workspace, set project folders, and select the type of configuration that will be used.<br />
<br />
==Project folder==<br />
Use '''Explorer''' view to manage source code, resources, and settings files for your projects.<br />
{| style="border-style: none;"<br />
|-<br />
|rowspan="2"| [[File:Vms ide explorer.png|200px|thumb|none|VMS IDE Explorer]]<br />
|style="vertical-align:top; padding-left: 20px;" | The project folder will store project settings and source files. To add a project folder<br />
# Create a folder on your local machine. <br />
# In Visual Studio Code, click the ''Explorer'' icon (<code>Ctrl+Shift+E</code>) in the Activity Bar<br />
# Click ''Open Folder'' and select the previously created folder.<br />
<br><br />
If you are working on a complex project with dependencies, you will likely need to add other projects to the current workspace.<br><br />
For this, just add another project folder as shown below.<br />
# Create another folder that will store files of the second project<br />
# In Visual Studio Code, select ''File > Add folder to workspace'' and select the folder you created.<br />
|}<br />
<br />
==End of line==<br />
Specify the End of Line character that will be used across all source files. '''You must use <code>LF</code>'''.<br />
# Open Visual Studio Code settings (<code>Ctrl+,</code>)<br />
# Navigate to ''Text Editor > Files > Eol'' (the default end of line character) and set it to ''\n''. <br />
<br />
==Type of configuration==<br />
Select the type of configuration for your project. The recommended type is '''FS'''.<br />
# Open Visual Studio Code settings (<code>Ctrl+,</code>)<br />
# Navigate to ''Extensions > VMS-IDE > Config-helper › Settings: Using'', and select one of the options:<br />
#* '''FS''' - save settings in local JSON files.<br />
#* '''VFS''' - save setting in VS Code virtual file system.<br />
#* '''VCS''' - manage settings using VS Code provided API.<br />
# Press <code>F1</code> and run the ''Reload window'' command or close Visual Studio Code and open it again.<br />
<br />
{| style="border-style: none;"<br />
! FS and VFS <br />
! VCS<br />
|-<br />
|style="padding-right: 20px;" | [[File:Syncronizer-settings-fs.png|600px|none|thumb|]]<br />
|style="padding-left: 20px;" | [[File:Syncronizer-settings-vsc.png|600px|thumb|none|]]<br />
|-<br />
|style="padding-right: 20px; text-align: center" | Settings are stored in a JSON file that can be easily modified in the editor.<br />
|style="padding-left: 20px; text-align: center" | Settings can be adjusted using Visual Studio Code settings page.<br />
|}<br />
<br />
'''NOTE''': Changing the type of configuration does not copy existing settings from one location to another.<br />
<br />
=SSH Configuration=<br />
The SSH connection to an OpenVMS machine is required for syncing source files, building and debugging projects. There are two ways of managing SSH connection settings.<br />
<br />
; Command : Press <code>F1</code> and run <code>VMS-IDE: Edit ssh-helper settings</code> command.<br />
<br />
; Project Explorer : <br />
:# Open [[VMS_IDE_Project_Explorer|'''Project Explorer''']]<br />
:# Select your project from the list<br />
:# In the ''PROJECT DESCRIPTION'' section, right-click ''SSH > host'' and select ''Edit''.<br />
<br />
==SSH Settings description==<br />
See [[SSH_Settings|''SSH settings'']] for more details.<br />
<br />
=Project Configuration=<br />
To open the project settings, press <code>F1</code> and run <code>VMS-IDE: Edit OpenVMS project settings</code> command or use [[VMS_IDE_Project_Explorer|'''Project Explorer''']] view.<br />
<br />
==Adjusting Settings==<br />
The project configuration procedure varies depending on the selected type of configuration.<br />
<br />
; FS or VFS : The Edit command loads current settings from memory and saves it to '''vmssoftware.synchronizer-settings.json''' file, then opens the file for editing.<br />
; VCS : The Edit command opens Workspace settings. Navigate to '''Synchronizer''' section and adjust the settings.<br />
<br />
==Settings description==<br />
The settings are split into two sections:<br />
* [[Project_Settings|''Project'']] - general project settings <br />
* [[Synchronize_Configuration|''Synchronize'']] - synchronizer specific settings<br />
<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_IDE_Project_Configuration&diff=709VMS IDE Project Configuration2019-04-16T09:46:39Z<p>Brett.cameron: </p>
<hr />
<div>=Workspace=<br />
When starting working on an OpenVMS project in the '''VMS IDE''', you need to configure your workspace, set project folders, and select the type of configuration that will be used.<br />
<br />
==Project folder==<br />
Use '''Explorer''' view to manage source code, resources, and settings files for your projects.<br />
{| style="border-style: none;"<br />
|-<br />
|rowspan="2"| [[File:Vms ide explorer.png|200px|thumb|none|VMS IDE Explorer]]<br />
|style="vertical-align:top; padding-left: 20px;" | The project folder will store project settings and source files. To add a project folder<br />
# Create a folder on your local machine. <br />
# In Visual Studio Code, click the ''Explorer'' icon (<code>Ctrl+Shift+E</code>) in the Activity Bar<br />
# Click ''Open Folder'' and select the previously created folder.<br />
<br><br />
If you are working on a complex project with dependencies, you will likely need to add other projects to the current workspace.<br><br />
For this, just add another project folder as shown below.<br />
# Create another folder that will store files of the second project<br />
# In Visual Studio Code, select ''File > Add folder to workspace'' and select the folder you created.<br />
|}<br />
<br />
==End of line==<br />
Specify the End of Line character that will be used across all source files. '''You must use <code>LF</code>'''.<br />
# Open Visual Studio Code settings (<code>Ctrl+,</code>)<br />
# Navigate to ''Text Editor > Files > Eol'' (the default end of line character) and set it to ''\n''. <br />
<br />
==Type of configuration==<br />
Select type of configuration for your project. Recommended type is '''FS'''.<br />
# Open Visual Studio Code settings (<code>Ctrl+,</code>)<br />
# Navigate to ''Extensions > VMS-IDE > Config-helper › Settings: Using'', and select one of the options:<br />
#* '''FS''' - save settings in local JSON files.<br />
#* '''VFS''' - save setting in VS Code virtual file system.<br />
#* '''VCS''' - manage settings using VS Code provided API.<br />
# Press <code>F1</code> and run ''Reload window'' command or close Visual Studio Code and open it again.<br />
<br />
{| style="border-style: none;"<br />
! FS and VFS <br />
! VCS<br />
|-<br />
|style="padding-right: 20px;" | [[File:Syncronizer-settings-fs.png|600px|none|thumb|]]<br />
|style="padding-left: 20px;" | [[File:Syncronizer-settings-vsc.png|600px|thumb|none|]]<br />
|-<br />
|style="padding-right: 20px; text-align: center" | Settings are stored in a JSON file that can be easily modified in the editor.<br />
|style="padding-left: 20px; text-align: center" | Settings can be adjusted using Visual Studio Code settings page.<br />
|}<br />
<br />
'''NOTE''': Changing the type of configuration does not copy existing settings from one location to another.<br />
<br />
=SSH Configuration=<br />
The SSH connection to an OpenVMS machine is required for syncing source files, building and debugging projects. There are two ways of managing SSH connection settings.<br />
<br />
; Command : Press <code>F1</code> and run <code>VMS-IDE: Edit ssh-helper settings</code> command.<br />
<br />
; Project Explorer : <br />
:# Open [[VMS_IDE_Project_Explorer|'''Project Explorer''']]<br />
:# Select your project from the list<br />
:# In the ''PROJECT DESCRIPTION'' section, right-click ''SSH > host'' and select ''Edit''.<br />
<br />
==SSH Settings description==<br />
See [[SSH_Settings|''SSH settings'']] for more details.<br />
<br />
=Project Configuration=<br />
To open the project settings, press <code>F1</code> and run <code>VMS-IDE: Edit OpenVMS project settings</code> command or use [[VMS_IDE_Project_Explorer|'''Project Explorer''']] view.<br />
<br />
==Adjusting Settings==<br />
The project configuration procedure varies depending on the selected type of configuration.<br />
<br />
; FS or VFS : The Edit command loads current settings from memory and saves it to '''vmssoftware.synchronizer-settings.json''' file, then opens the file for editing.<br />
; VCS : The Edit command opens Workspace settings. Navigate to '''Synchronizer''' section and adjust the settings.<br />
<br />
==Settings description==<br />
The settings are split into two sections:<br />
* [[Project_Settings|''Project'']] - general project settings <br />
* [[Synchronize_Configuration|''Synchronize'']] - synchronizer specific settings<br />
<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_IDE_Project_Configuration&diff=708VMS IDE Project Configuration2019-04-16T09:45:53Z<p>Brett.cameron: </p>
<hr />
<div>=Workspace=<br />
When starting working on an OpenVMS project in the '''VMS IDE''', you need to configure your workspace, set project folders, and select the type of configuration that will be used.<br />
<br />
==Project folder==<br />
Use '''Explorer''' view to manage source code, resources, and settings files for your projects.<br />
{| style="border-style: none;"<br />
|-<br />
|rowspan="2"| [[File:Vms ide explorer.png|200px|thumb|none|VMS IDE Explorer]]<br />
|style="vertical-align:top; padding-left: 20px;" | The project folder will store project settings and source files. To add a project folder<br />
# Create a folder on your local machine. <br />
# In Visual Studio Code, click the ''Explorer'' icon (<code>Ctrl+Shift+E</code>) in the Activity Bar<br />
# Click ''Open Folder'' and select the previously created folder.<br />
<br><br />
If you are working on a complex project with dependencies, you will likely need to add other projects to the current workspace.<br><br />
For this, just add another project folder as shown below.<br />
# Create another folder that will store files of the second project<br />
# In Visual Studio Code, select ''File > Add folder to workspace'' and select the folder you created.<br />
|}<br />
<br />
==End of line==<br />
Specify the End of Line character that will be used across all source files. '''You must use <code>LF</code>'''.<br />
# Open Visual Studio Code settings (<code>Ctrl+,</code>)<br />
# Navigate to ''Text Editor > Files > Eol'' (The default end of line character) and set it to ''\n''. <br />
<br />
==Type of configuration==<br />
Select type of configuration for your project. Recommended type is '''FS'''.<br />
# Open Visual Studio Code settings (<code>Ctrl+,</code>)<br />
# Navigate to ''Extensions > VMS-IDE > Config-helper › Settings: Using'', and select one of the options:<br />
#* '''FS''' - save settings in local JSON files.<br />
#* '''VFS''' - save setting in VS Code virtual file system.<br />
#* '''VCS''' - manage settings using VS Code provided API.<br />
# Press <code>F1</code> and run ''Reload window'' command or close Visual Studio Code and open it again.<br />
<br />
{| style="border-style: none;"<br />
! FS and VFS <br />
! VCS<br />
|-<br />
|style="padding-right: 20px;" | [[File:Syncronizer-settings-fs.png|600px|none|thumb|]]<br />
|style="padding-left: 20px;" | [[File:Syncronizer-settings-vsc.png|600px|thumb|none|]]<br />
|-<br />
|style="padding-right: 20px; text-align: center" | Settings are stored in a JSON file that can be easily modified in the editor.<br />
|style="padding-left: 20px; text-align: center" | Settings can be adjusted using Visual Studio Code settings page.<br />
|}<br />
<br />
'''NOTE''': Changing the type of configuration does not copy existing settings from one location to another.<br />
<br />
=SSH Configuration=<br />
The SSH connection to an OpenVMS machine is required for syncing source files, building and debugging projects. There are two ways of managing SSH connection settings.<br />
<br />
; Command : Press <code>F1</code> and run <code>VMS-IDE: Edit ssh-helper settings</code> command.<br />
<br />
; Project Explorer : <br />
:# Open [[VMS_IDE_Project_Explorer|'''Project Explorer''']]<br />
:# Select your project from the list<br />
:# In the ''PROJECT DESCRIPTION'' section, right-click ''SSH > host'' and select ''Edit''.<br />
<br />
==SSH Settings description==<br />
See [[SSH_Settings|''SSH settings'']] for more details.<br />
<br />
=Project Configuration=<br />
To open the project settings, press <code>F1</code> and run <code>VMS-IDE: Edit OpenVMS project settings</code> command or use [[VMS_IDE_Project_Explorer|'''Project Explorer''']] view.<br />
<br />
==Adjusting Settings==<br />
The project configuration procedure varies depending on the selected type of configuration.<br />
<br />
; FS or VFS : The Edit command loads current settings from memory and saves it to '''vmssoftware.synchronizer-settings.json''' file, then opens the file for editing.<br />
; VCS : The Edit command opens Workspace settings. Navigate to '''Synchronizer''' section and adjust the settings.<br />
<br />
==Settings description==<br />
The settings are split into two sections:<br />
* [[Project_Settings|''Project'']] - general project settings <br />
* [[Synchronize_Configuration|''Synchronize'']] - synchronizer specific settings<br />
<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_IDE_Project_Configuration&diff=707VMS IDE Project Configuration2019-04-16T09:43:29Z<p>Brett.cameron: </p>
<hr />
<div>=Workspace=<br />
When starting working on an OpenVMS project in the '''VMS IDE''', you need to configure your workspace, set project folders, and select the type of configuration that will be used.<br />
<br />
==Project folder==<br />
Use '''Explorer''' view to manage source code, resources, and settings files for your projects.<br />
{| style="border-style: none;"<br />
|-<br />
|rowspan="2"| [[File:Vms ide explorer.png|200px|thumb|none|VMS IDE Explorer]]<br />
|style="vertical-align:top; padding-left: 20px;" | Project folder will store project settings and source files. To add a project folder<br />
# Create a folder on your machine. <br />
# In Visual Studio Code, click the ''Explorer'' icon (<code>Ctrl+Shift+E</code>) in the Activity Bar<br />
# Click ''Open Folder'' and select the previously created folder.<br />
<br><br />
If you are working on a complex project with dependencies, you will likely need to add other projects to the current workspace.<br><br />
For this, just add another project folder as shown below.<br />
# Create another folder that will store files of the second project<br />
# In Visual Studio Code, select ''File > Add folder to workspace'' and select the folder you created.<br />
|}<br />
<br />
==End of line==<br />
Specify the End of Line character that will be used across all source files. '''You must use <code>LF</code>'''.<br />
# Open Visual Studio Code settings (<code>Ctrl+,</code>)<br />
# Navigate to ''Text Editor > Files > Eol'' (The default end of line character) and set it to ''\n''. <br />
<br />
==Type of configuration==<br />
Select type of configuration for your project. Recommended type is '''FS'''.<br />
# Open Visual Studio Code settings (<code>Ctrl+,</code>)<br />
# Navigate to ''Extensions > VMS-IDE > Config-helper › Settings: Using'', and select one of the options:<br />
#* '''FS''' - save settings in local JSON files.<br />
#* '''VFS''' - save setting in VS Code virtual file system.<br />
#* '''VCS''' - manage settings using VS Code provided API.<br />
# Press <code>F1</code> and run ''Reload window'' command or close Visual Studio Code and open it again.<br />
<br />
{| style="border-style: none;"<br />
! FS and VFS <br />
! VCS<br />
|-<br />
|style="padding-right: 20px;" | [[File:Syncronizer-settings-fs.png|600px|none|thumb|]]<br />
|style="padding-left: 20px;" | [[File:Syncronizer-settings-vsc.png|600px|thumb|none|]]<br />
|-<br />
|style="padding-right: 20px; text-align: center" | Settings are stored in a JSON file that can be easily modified in the editor.<br />
|style="padding-left: 20px; text-align: center" | Settings can be adjusted using Visual Studio Code settings page.<br />
|}<br />
<br />
'''NOTE''': Changing the type of configuration does not copy existing settings from one location to another.<br />
<br />
=SSH Configuration=<br />
The SSH connection to an OpenVMS machine is required for syncing source files, building and debugging projects. There are two ways of managing SSH connection settings.<br />
<br />
; Command : Press <code>F1</code> and run <code>VMS-IDE: Edit ssh-helper settings</code> command.<br />
<br />
; Project Explorer : <br />
:# Open [[VMS_IDE_Project_Explorer|'''Project Explorer''']]<br />
:# Select your project from the list<br />
:# In the ''PROJECT DESCRIPTION'' section, right-click ''SSH > host'' and select ''Edit''.<br />
<br />
==SSH Settings description==<br />
See [[SSH_Settings|''SSH settings'']] for more details.<br />
<br />
=Project Configuration=<br />
To open the project settings, press <code>F1</code> and run <code>VMS-IDE: Edit OpenVMS project settings</code> command or use [[VMS_IDE_Project_Explorer|'''Project Explorer''']] view.<br />
<br />
==Adjusting Settings==<br />
The project configuration procedure varies depending on the selected type of configuration.<br />
<br />
; FS or VFS : The Edit command loads current settings from memory and saves it to '''vmssoftware.synchronizer-settings.json''' file, then opens the file for editing.<br />
; VCS : The Edit command opens Workspace settings. Navigate to '''Synchronizer''' section and adjust the settings.<br />
<br />
==Settings description==<br />
The settings are split into two sections:<br />
* [[Project_Settings|''Project'']] - general project settings <br />
* [[Synchronize_Configuration|''Synchronize'']] - synchronizer specific settings<br />
<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_IDE_Project_Configuration&diff=706VMS IDE Project Configuration2019-04-16T09:42:42Z<p>Brett.cameron: </p>
<hr />
<div>=Workspace=<br />
When starting working on an OpenVMS project in the '''VMS IDE''', you need to configure your workspace, set project folders, and select the type of configuration that will be used.<br />
<br />
==Project folder==<br />
Use '''Explorer''' view to manage source code, resources, and settings files of your projects.<br />
{| style="border-style: none;"<br />
|-<br />
|rowspan="2"| [[File:Vms ide explorer.png|200px|thumb|none|VMS IDE Explorer]]<br />
|style="vertical-align:top; padding-left: 20px;" | Project folder will store project settings and source files. To add a project folder<br />
# Create a folder on your machine. <br />
# In Visual Studio Code, click the ''Explorer'' icon (<code>Ctrl+Shift+E</code>) in the Activity Bar<br />
# Click ''Open Folder'' and select the previously created folder.<br />
<br><br />
If you are working on a complex project with dependencies, you will likely need to add other projects to the current workspace.<br><br />
For this, just add another project folder as shown below.<br />
# Create another folder that will store files of the second project<br />
# In Visual Studio Code, select ''File > Add folder to workspace'' and select the folder you created.<br />
|}<br />
<br />
==End of line==<br />
Specify the End of Line character that will be used across all source files. '''You must use <code>LF</code>'''.<br />
# Open Visual Studio Code settings (<code>Ctrl+,</code>)<br />
# Navigate to ''Text Editor > Files > Eol'' (The default end of line character) and set it to ''\n''. <br />
<br />
==Type of configuration==<br />
Select type of configuration for your project. Recommended type is '''FS'''.<br />
# Open Visual Studio Code settings (<code>Ctrl+,</code>)<br />
# Navigate to ''Extensions > VMS-IDE > Config-helper › Settings: Using'', and select one of the options:<br />
#* '''FS''' - save settings in local JSON files.<br />
#* '''VFS''' - save setting in VS Code virtual file system.<br />
#* '''VCS''' - manage settings using VS Code provided API.<br />
# Press <code>F1</code> and run ''Reload window'' command or close Visual Studio Code and open it again.<br />
<br />
{| style="border-style: none;"<br />
! FS and VFS <br />
! VCS<br />
|-<br />
|style="padding-right: 20px;" | [[File:Syncronizer-settings-fs.png|600px|none|thumb|]]<br />
|style="padding-left: 20px;" | [[File:Syncronizer-settings-vsc.png|600px|thumb|none|]]<br />
|-<br />
|style="padding-right: 20px; text-align: center" | Settings are stored in a JSON file that can be easily modified in the editor.<br />
|style="padding-left: 20px; text-align: center" | Settings can be adjusted using Visual Studio Code settings page.<br />
|}<br />
<br />
'''NOTE''': Changing the type of configuration does not copy existing settings from one location to another.<br />
<br />
=SSH Configuration=<br />
The SSH connection to an OpenVMS machine is required for syncing source files, building and debugging projects. There are two ways of managing SSH connection settings.<br />
<br />
; Command : Press <code>F1</code> and run <code>VMS-IDE: Edit ssh-helper settings</code> command.<br />
<br />
; Project Explorer : <br />
:# Open [[VMS_IDE_Project_Explorer|'''Project Explorer''']]<br />
:# Select your project from the list<br />
:# In the ''PROJECT DESCRIPTION'' section, right-click ''SSH > host'' and select ''Edit''.<br />
<br />
==SSH Settings description==<br />
See [[SSH_Settings|''SSH settings'']] for more details.<br />
<br />
=Project Configuration=<br />
To open the project settings, press <code>F1</code> and run <code>VMS-IDE: Edit OpenVMS project settings</code> command or use [[VMS_IDE_Project_Explorer|'''Project Explorer''']] view.<br />
<br />
==Adjusting Settings==<br />
The project configuration procedure varies depending on the selected type of configuration.<br />
<br />
; FS or VFS : The Edit command loads current settings from memory and saves it to '''vmssoftware.synchronizer-settings.json''' file, then opens the file for editing.<br />
; VCS : The Edit command opens Workspace settings. Navigate to '''Synchronizer''' section and adjust the settings.<br />
<br />
==Settings description==<br />
The settings are split into two sections:<br />
* [[Project_Settings|''Project'']] - general project settings <br />
* [[Synchronize_Configuration|''Synchronize'']] - synchronizer specific settings<br />
<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_IDE_Installation&diff=705VMS IDE Installation2019-04-16T09:40:42Z<p>Brett.cameron: </p>
<hr />
<div>=Overview=<br />
'''VMS IDE''' is built on top of Microsoft Visual Studio Code, a light-weight but powerful cross-platform source code editor. <br />
<br />
=Installation=<br />
# Download and install the official [https://code.visualstudio.com/ Microsoft Visual Studio Code] editor. Refer to Visual Studio Code [https://code.visualstudio.com/docs/setup/setup-overview documentation] for installation instructions.<br />
# Run the Visual Studio Code editor.<br />
# Click the Extensions icon in the Activity Bar on the left side of the Visual Studio Code (<code>Ctrl+Shift+X</code>).<br />
# Search for VMS IDE, select it from the list and click Install.<br />
<br />
===Installed extension===<br />
[[File:Vms-ide-extension.png|800px|none|thumb|VMS IDE Extension]]<br />
<br />
=References=<br />
* [https://code.visualstudio.com/ Microsoft Visual Studio Code]<br />
* [https://code.visualstudio.com/docs Visual Studio Code documentation]<br />
* [https://code.visualstudio.com/docs/getstarted/introvideos Visual Studio Code introductory videos]<br />
<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_IDE&diff=704VMS IDE2019-04-16T09:39:49Z<p>Brett.cameron: </p>
<hr />
<div>{| style="float:center;vertical-align:top;background-color:white;"<br />
| <br />
{| class="wikitable" <br />
! style="text-align:center; background-color:#067ACC;color:white;height:50px;width:550px;" | This material is under construction. The VS Code extensions are coming soon.<br />
|}<br />
|}<br />
<br />
'''VMS IDE''' is an integrated development environment that enables you to quickly and easily develop comprehensive applications for OpenVMS system. It provides a set of tools for developing, building, and debugging OpenVMS projects.<br />
<br />
=Features=<br />
[[File:Vms ide.png|800px|thumb|none|VMS IDE]]<br />
* Source code '''synchronization''' between the local machine and OpenVMS system.<br />
* '''SSH connection''' setup to the remote OpenVMS system.<br />
* '''Projects Explorer''' as a simple and convenient way to manage OpenVMS projects.<br />
* '''Debugger''' for OpenVMS projects.<br />
* '''Syntax highlighting''' for '''MMS''', '''CLD''', and '''MSG''' files.<br />
* '''Code autocompletion''' for '''MSG''' and '''CLD''' files.<br />
<br />
=Getting Started=<br />
This guide will help you install the VMS IDE extension and start working on your projects.<br />
<br />
===Quick Start===<br />
* [[VMS_IDE_Installation|Installation]]<br />
* [[VMS_IDE_Project_Configuration|Setting up a VMS Project]]<br />
* [[VMS_IDE_Developing|Working on a VMS Project]]<br />
<br />
===Commands===<br />
* [[VMS_IDE_Commands|VMS IDE Commands]]<br />
<br />
===Components===<br />
* [[VMS_IDE_Project_Explorer|Project Explorer]]<br />
* [[VMS_IDE_Debugger|Debugger]]<br />
<br />
<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_IDE&diff=703VMS IDE2019-04-16T09:39:18Z<p>Brett.cameron: </p>
<hr />
<div>{| style="float:center;vertical-align:top;background-color:white;"<br />
| <br />
{| class="wikitable" <br />
! style="text-align:center; background-color:#067ACC;color:white;height:50px;width:550px;" | This material is under construction. The VS Code extensions are coming soon.<br />
|}<br />
|}<br />
<br />
'''VMS IDE''' is an integrated development environment that enables you to quickly and easily develop comprehensive applications for OpenVMS system. It provides a set of tools for developing, building, and debugging OpenVMS projects.<br />
<br />
=Features=<br />
[[File:Vms ide.png|800px|thumb|none|VMS IDE]]<br />
* Source code '''synchronization''' between the local machine and OpenVMS system.<br />
* '''SSH connection''' setup to the remote OpenVMS system.<br />
* '''Projects Explorer''' as a simple and convenient way to manage OpenVMS projects.<br />
* '''Debugger''' for OpenVMS projects.<br />
* '''Syntax highlighting''' for '''MMS''', '''CLD''', and '''MSG''' files.<br />
* '''Code autocompletion''' for '''MSG''' and '''CLD''' files.<br />
<br />
=Getting Started=<br />
This guide will help you install the VMS IDE extension and start working on your projects.<br />
<br />
===Quick Start===<br />
* [[VMS_IDE_Installation|Installation]]<br />
* [[VMS_IDE_Project_Configuration|Setting up VMS Project]]<br />
* [[VMS_IDE_Developing|Working on VMS Project]]<br />
<br />
===Commands===<br />
* [[VMS_IDE_Commands|VMS IDE Commands]]<br />
<br />
===Components===<br />
* [[VMS_IDE_Project_Explorer|Project Explorer]]<br />
* [[VMS_IDE_Debugger|Debugger]]<br />
<br />
<br />
[[Category:VMS IDE]]</div>Brett.cameronhttps://wiki.vmssoftware.com/index.php?title=VMS_IDE&diff=702VMS IDE2019-04-16T09:38:20Z<p>Brett.cameron: </p>
<hr />
<div>{| style="float:center;vertical-align:top;background-color:white;"<br />
| <br />
{| class="wikitable" <br />
! style="text-align:center; background-color:#067ACC;color:white;height:50px;width:550px;" | This material is under construction. The VS Code extensions are coming soon.<br />
|}<br />
|}<br />
<br />
'''VMS IDE''' is an integrated development environment that enables you to quickly and easily develop comprehensive applications for OpenVMS system. It provides a set of tools for developing, building, and debugging OpenVMS projects.<br />
<br />
=Features=<br />
[[File:Vms ide.png|800px|thumb|none|VMS IDE]]<br />
* Source code '''synchronization''' between the local machine and OpenVMS system.<br />
* '''SSH connection''' setup to the remote OpenVMS system.<br />
* '''Projects Explorer''' as a simple and convenient way to manage OpenVMS projects.<br />
* '''Debugger''' for OpenVMS projects.<br />
* '''Syntax highlighting''' for '''MMS''', '''CLD''', and '''MSG''' files.<br />
* '''Code autocompletion''' for '''MSG''' and '''CLD''' files.<br />
<br />
=Getting Started=<br />
This guide will help you install VMS IDE extension and start working on your projects.<br />
<br />
===Quick Start===<br />
* [[VMS_IDE_Installation|Installation]]<br />
* [[VMS_IDE_Project_Configuration|Setting up VMS Project]]<br />
* [[VMS_IDE_Developing|Working on VMS Project]]<br />
<br />
===Commands===<br />
* [[VMS_IDE_Commands|VMS IDE Commands]]<br />
<br />
===Components===<br />
* [[VMS_IDE_Project_Explorer|Project Explorer]]<br />
* [[VMS_IDE_Debugger|Debugger]]<br />
<br />
<br />
[[Category:VMS IDE]]</div>Brett.cameron