#File system
##Directories and files with the same name are allowed
##File has a version, therefore two files with the same name might have different content
##Shared stream I/O does not work.
##To guarantee the file content is on the disk user have to use <code>fsync()</code> function.
##Because of using logical names the real file path may be different from path used to open file.
##File has no access time attribute.
##Changing the file permissions also changes its modification time.
##Changing content of directory does not change directory modification time.
##File has four rights bits - read, write, execute and delete. In unix it has three of it - read, write and execute.
##‘.DIR’ extension is reserved
##Non-blocking file IO does not supported in CRTL.
##There are a lot of issues with symbolic link implementation
##Symbol '$' is usual for file and directory names
##OpenVMS <code>chmod(0)</code> sets user's default permissions, not resets them
##To delete directory user has to have ‘delete’ permission for this directory
##OpenVMS creates all intermediate directories on <code>mkdir()</code>
#Process
##There is no normal <code>fork()</code>, <code>spawn()</code> function.
##Pipes are created via mailbox and have a lot of compatibility issues.
##If child has threads, each thread posts 'END-OF-PIPE' when it finishes.
##There is no normal <code>select()</code>, <code>poll()</code> e.t.c
##<code>siginterrupt()</code> is not supported
##A lot of issues with signals
##Interrupting I/O operation may hang
##There is no root user with zero uid
##There is no unix commands like: echo, exit …
##OpenVMS cannot handle recursion overflow properly - just crashes
#Sockets
##<code>AF_UNIX</code> has different meaning
##Binding socket to empty address fails (wildcard resolved to multiple address).
##<code>getpeername()</code> returns ‘0.0.0.0’ instead of error
##OpenVMS crashed on <code>socket.socket.sendall</code>
#Time
##<code>time_t</code> is unsigned
##<code>strftime()</code>
###Does not support %G format
###Undefined behavior when format ends with '%'
###‘%4Y’ is padded with spaces
#Miscellaneous
##Environment variables have unusual implementation - through logical names. There is no appropriate way to get all environment variables.
##OpenVMS sqlite3 port does not support "OR ROLLBACK"
##Program prints crush dump
##<code>locale.strxfrm()</code> works unusual
#Compiler
##<code>uint_ptr</code> is always 64 bit, void* is 32 bit or 64 bit
##Compiler does not support relative include paths
----
[[Category:VMS IDE]]

VMS-Specific Python Modules

2020-09-04T04:10:31Z

Sergey vorfolomeev:

VMS specific Python modules.
== vms.decc ==
 Wraps the '''C Run-Time Library for OpenVMS Systems''' functions. 
----
=== dlopen_test(name:str)->int ===
Tries to open a shared image.
;parameters
: <code>name:str</code> path to the shared image
;returns
: <code>1</code> if the shared image exists and can be opened by dlopen()
: <code>0</code> otherwise
----
=== fix_time(vms_time:int)->int ===
Converts VMS time to the Unix time.
;parameters
: <code>vms_time:int</code> VMS system time
;returns
:Time in Unix format (seconds that have elapsed since 1970.01.01)
----
=== from_vms(vms_path:str, wild_flag:int)->list ===
Converts VMS path to a list of Unix paths.
;parameters
: <code>vms_path:str</code> path in VMS format (supports wildcards)
: <code>wild_flag:int</code> If set to <code>0</code>, wildcards found in the <code>vms_path</code> are not expanded
;returns
:List of paths in Unix format
----
=== getenv(name:str, def_value:str)->str ===
Gets the specified environment variable value. See getenv() description in the '''C Run-Time Library Reference Manual for OpenVMS Systems''' documentation.
;parameters
: <code>name:str</code> name of the environment variable
: <code>def_value:str</code> default value
;returns
:Environment variable value
----
=== sleep(seconds:int)->int ===
Suspends execution of the current process or thread for the specified number of seconds.
;parameters
: <code>seconds:int</code> seconds to sleep
;returns
:The number of seconds left to the end of the sleep period if sleep is interrupted. <code>0</code> if the process slept for the specified number of seconds.
----
=== sysconf(name:int)->int ===
Provides a method for determining the current value of a configurable system limit or whether optional features are supported.
;parameters
: <code>name:int</code> system variable to be queried
;returns
:Requested value
----
=== to_vms(unix_path:str, allow_wild:int, no_directory:int)->list ===
Converts UNIX style file specifications to OpenVMS file specifications.
;parameters
: <code>unix_path:str</code> file name in UNIX style file specification format
: <code>allow_wild:int</code> If set to <code>0</code>, wildcards found in <code>unix_path</code> are not expanded
: <code>no_directory:int</code> An integer that has one of the following values:
:* 0 - Directory allowed
:* 1 - Prevent expansion of the string as a directory name
:* 2 - Force expansion of the string as a directory name
;returns
List of paths in OpenVMS style
----
=== unixtime(vms_time:int)->int ===
Converts OpenVMS system time to the Unix local time.
;parameters
: <code>vms_time:int</code> OpenVMS system time
;returns
:Unix time
----
=== vmstime(unix_time:int)->int ===
Converts Unix time to the OpenVMS system time.
;parameters
: <code>unix_time:int</code> Unix time
;returns
OpenVMS system time
----
== vms.ile3 ==
 Provides functions for working with the list. 
----
=== new()->object ===
Creates empty item list.
;parameters
:<code>None</code>
;returns
:New empty item list
----
=== delete(il:object)->None ===
Deletes item list.
;parameters
: <code>il:object</code> item list to be removed
;returns
:OpenVMS system time
----
=== size(il:object)->int ===
Gets size of the item list.
;parameters
: <code>il:object</code> item list
;returns
:The size of the specified item list
----
=== addint(il:object, item:int, item_type:int, item_value:int)->None ===
Adds a new integer to the item list.
;parameters
: <code>il:object</code> item list
: <code>item:int</code> item to add
: <code>item_type:int</code> type of the item. See '''vms.dscdef'''
: <code>item_value:int</code> value of the item
;returns
:<code>None</code>
----
=== getint(il:object, index:int)->int ===
Gets the integer at the specified index in the list.
;parameters
: <code>il:object</code> item list
: <code>index:int</code> index of the item to get
;returns
:Integer value
----
=== gethex(il:object, index:int)->str ===
Gets the integer at the specified index in the item list and returns it as a hexadecimal string.
;parameters
: <code>il:object</code> item list
: <code>index:int</code> index of the item to get
;returns
:Hexadecimal string
----
=== addstr(il:object, item:int, item_value:str, item_length:int)->None ===
Adds the specified string to the item list. If the <code>item_value</code> is not <code>None</code>, the <code>item_length</code> is ignored and the length of the buffer will be the same as the length of the <code>item_value</code>.
;parameters
: <code>il:object</code> item list
: <code>item:int</code> item to add
: <code>item_value:str</code> value to add (or <code>None</code>)
: <code>item_length:int</code> length of the buffer if the <code>item_value</code> is <code>None</code>
;returns
:<code>None</code>
----
=== addstrd(il:object, item:int, item_value:str, item_length:int)->None ===
Adds the specified space-expanded string to the item list. The first byte of the buffer is the length of the string. If the <code>item_value</code> is longer than the <code>item_length</code>, it will be truncated.
;parameters
: <code>il:object</code> item list
: <code>item:int</code> item to add
: <code>item_value:str</code> value to add
: <code>item_length:int</code> length of the buffer (the resulting string length is one byte less)
;returns
:<code>None</code>
----
=== addstrn(il:object, item:int, item_value:str, item_length:int)->None ===
Adds the specified space-expanded string to the item list. If the <code>item_value</code> is longer than the <code>item_length</code>, it will be truncated.
;parameters
: <code>il:object</code> item list
: <code>item:int</code> item to add
: <code>item_value:str</code> value to add
: <code>item_length:int</code> length of the buffer
;returns
:<code>None</code>
----
=== getstr(il:object, index:int, flag:int)->str ===
Gets the string at the specified index in the item list.
;parameters
: <code>il:object</code> item list
: <code>index:int</code> index of the item to get
: <code>flag:int</code> if set to <code>1</code>, the first byte of the resulting string is the length of the string
;returns
:String
----
=== addbin(il:object, item:int, item_value:int, item_offset:int, item_len:int)->None ===
Adds a new binary item to the list. It will be interpreted as a string.
;parameters
: <code>il:object</code> item list
: <code>item:int</code> item to add
: <code>item_value:int</code> value to store
: <code>item_offset:int</code> starting byte
: <code>item_len:int</code> amount of bytes
;returns
:<code>None</code>
----
=== getbyte(il:object, index:int, item_offset:int)->int ===
Gets the byte at the specified position in the item list.
;parameters
: <code>il:object</code> item list
: <code>index:int</code> index of the item
: <code>item_offset:int</code> starting byte
;returns
:Integer value of the specified byte
----
== vms.lib ==
 Wraps the '''OpenVMS RTL Library(LIB$)''' functions. 
----
=== create_dir(name:str, uic:int, pe:int, pv:int)->int ===
Creates a directory.
;parameters
: <code>name:str</code> name of the directory to be created (specified in OpenVMS style)
: <code>uic:int</code> unsigned integer value of the owner UIC:
:*<code>None</code> - the current user
:*<code>0</code> - owner of the parent directory
: <code>pe:int</code> protection enable. See full documentation in the '''OpenVMS RTL Library(LIB$) Manual''' for LIB$CREATE_DIR.
: <code>pv:int</code> protection value
;returns
: <code>vms.ssdef.SS__CREATED</code> one or more directories created
: <code>vms.ssdef.SS__NORMAL</code> all specified directories already exist
: another error. See in '''vms.ssdef'''
----
=== date_time()->list ===
Gets current date and time.
;parameters
:<code>None</code>
;returns
:The list:
:*<code>int</code> status code of the operation
:*<code>str</code> resulting string
----
=== get_ef()->list ===
Allocates a local event flag.
;parameters
:<code>None</code>
;returns
:The list:
:*<code>int</code> status code of the operation
:*<code>int</code> resulting event flag
----
=== free_ef(ef:int)->int ===
Releases the local event flag.
;parameters
: <code>ef:int</code> the local event flag
;returns
:Status code of the operation
----
=== put_common(common:str)->int ===
Copies a string into the common area.
;parameters
: <code>common:str</code> string to copy
;returns
:Status code of the operation
----
=== get_common()->list ===
Gets the string from the common area.
;parameters
:<code>None</code>
;returns
:The list:
:*<code>int</code> status code of the operation
:*<code>str</code> resulting string
----
=== get_hostname(flags:int)->list ===
Gets the host name of the local system.
;parameters
: <code>flags:int</code> if set to <code>1</code>, the host node name is returned in the parsable form
;returns
:The list:
:*<code>int</code> status code of the operation
:*<code>str</code> resulting host node name
----
=== getjpi(item_code:int, pid:int, pname:str)->list ===
Gets the specified job/process information as a string.
;parameters
: <code>item_code:int</code> item identifier code defining the item of information to be returned. See '''vms.jpidef'''
: <code>pid:int</code> process id
: <code>pname:str</code> process name
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.
;returns
:The list:
:*<code>int</code> status code of the operation
:*<code>str</code> resulting string
----
=== getsyi(item_code:int, node_name:str)->list ===
Gets system wide information as a string.
;parameters
: <code>item_code:int</code> item identifier code defining the item of information to be returned. See '''vms.syidef'''
: <code>node_name:str</code> node name
;returns
:The list:
:*<code>int</code> status code of the operation
:*<code>str</code> resulting string
:*<code>int</code> resulting cluster system id
----
=== spawn(command:str, input_file:str, output_file:str, flags:int, pname:str)->list ===
Requests the command language interpreter (CLI) of the calling process to spawn a subprocess for executing CLI commands.
;parameters
: <code>command:str</code> command to execute
: <code>input_file:str</code> equivalence name to be associated with the logical name SYS$INPUT
: <code>output_file:str</code> equivalence name to be associated with the logical name SYS$OUTPUT
: <code>flags:int</code> flag bits that designate optional behavior. See '''vms.clidef'''
: <code>pname:str</code> name defined for the subprocess
;returns
:The list:
:*<code>int</code> status code of the operation
:*<code>int</code> process id of the spawned process
----
=== do_command(command:str)->None ===
Stops program execution and directs the command language interpreter (CLI) to execute a command that is supplied as the argument.
;parameters
: <code>command:str</code> command to execute
;returns
:If successful, it does not return control to the calling program.
----
== vms.sys ==
 Wraps the '''OpenVMS System Services''' functions. 
----
=== asctim(vms_time:int, time_only:int)->list ===
Converts an absolute or delta time from 64-bit system time format to an ASCII string.
;parameters
: <code>vms_time:int</code> OpenVMS system time. A negative time value represents a delta time.
: <code>time_only:int</code> if set to <code>1</code>, asctim returns the hour only.
;returns
:The list:
:*<code>int</code> status code of the operation
:*<code>str</code> resulting string
----
=== bintim(time_str:str)->list ===
Converts an ASCII string to an absolute or delta time value in the system 64-bit time format.
;parameters
: <code>time_str:str</code> in format:
:* Absolute Time: dd-mmm-yyyy hh:mm:ss.cc
:* Delta Time: dddd hh:mm:ss.cc
;returns
:The list:
:* <code>int</code> status code of the operation
:* <code>int</code> resulting time value
----
=== asctoid(name:str)->list ===
Translates the specified identifier name into its binary identifier value.
;parameters
: <code>name:str</code> identifier name
;returns
:The list:
:* <code>int</code> status code of the operation
:* <code>int</code> resulting identifier value
:* <code>int</code> resulting identifier attributes. See '''vms.kgbdef'''
----
=== idtoasc(id_val:int, context:int)->list ===
Translates the specified identifier value to the identifier name.
;parameters
: <code>id_val:int</code> identifier value. See '''OpenVMS System Services Reference Manual''' for SYS$IDTOASC
: <code>context:int</code> context value used when <code>idtoasc</code> is called repeatedly. Must be initialized with the value 0.
;returns
:The list:
:* <code>int</code> status code of the operation
:* <code>str</code> resulting identifier name
:* <code>int</code> resulting identifier value
:* <code>int</code> resulting identifier attributes. See '''vms.kgbdef'''
:* <code>int</code> resulting context
----
=== crembx(tmp:int, maxmsg:int, bufquo:int, promsk:int, acmode:int, mbx_name:string, flags:int)->list ===
Creates a virtual mailbox device.
;parameters
: <code>tmp:int</code> the first bit specifies a permanent mailbox
: <code>maxmsg:int</code> maximum size of a message (in bytes)
: <code>bufquo:int</code> number of bytes of system dynamic memory that can be used to buffer messages sent to the mailbox
: <code>promsk:int</code> protection mask to be associated with the created mailbox
: <code>acmode:int</code> access mode to be associated with the channel to which the mailbox is assigned
: <code>mbx_name:string</code> logical name to be assigned to the mailbox
: <code>flags:int</code> options for the assign operation. See '''vms.cmbdef'''
;returns
:The list:
:* <code>int</code> status code of the operation
:* <code>int</code> resulting channel
----
=== delmbx(channel:int)->int ===
Marks a permanent mailbox for deletion.
;parameters
: <code>channel:int</code> mailbox channel
;returns
:Status code
----
=== assign(devnam:str, acmode:int, mbxnam:str, flags:int)->list ===
Provides a process with an I/O channel.
;parameters
: <code>devnam:str</code> name of the device
: <code>acmode:int</code> access mode to be associated with the channel
: <code>mbxnam:str</code> logical name of the mailbox to be associated with the device
: <code>flags:int</code> an optional device-specific argument
;returns
:The list:
:* <code>int</code> status code of the operation
:* <code>int</code> resulting channel
----
=== dassgn(channel:int)->int ===
Unassigns (releases) an I/O channel.
;parameters
: <code>channel:int</code> number of the I/O channel to be unassigned
;returns
:Status code
----
=== readvblk(channel:int, max_read:int, block:int, fmod:int)->list ===
Read from I/O channel.
;parameters
: <code>channel:int</code> I/O channel
: <code>max_read:int</code> amount of bytes to read
: <code>block:int</code> starting block
: <code>fmod:int</code> function code modifiers
;returns
:The list:
:* <code>int</code> status code of the operation
:* <code>byte</code> resulting buffer
:* <code>int</code> I/O completion code
----
=== writevblk(channel:int, buffer:bytes, block:int, fmod:int)->list ===
Write to I/O channel.
;parameters
: <code>channel:int</code> I/O channel
: <code>buffer:bytes</code> bytes to write
: <code>block:int</code> starting block
: <code>fmod:int</code> function code modifiers
;returns
:The list:
:* <code>int</code> status code of the operation
:* <code>int</code> amount of written bytes
:* <code>int</code> I/O completion code
----
=== cancel(channel:int)->int ===
Cancel I/O operation.
;parameters
: <code>channel:int</code> I/O channel
;returns
:Status code
----
=== crelnm(attr:int, tabnam:str, lognam:str, acmode:int, il:object)->int ===
Creates a logical name and specifies its equivalence names.
;parameters
: <code>attr:int</code> attributes to be associated with the logical name. See '''vms.lnmdef'''
: <code>tabnam:str</code> name of the table in which to create the logical name
: <code>lognam:str</code> logical name to be created
: <code>acmode:int</code> access mode to be associated with the logical name. See '''vms.psldef'''
: <code>il:object</code> item list, created via [[VMS specific Python modules#new()->object|<code>vms.ile3.new()</code>]]
See '''OpenVMS System Services Reference Manual''' for SYS$CRELNM.
;returns
:Status code
----
=== trnlnm(attr:int, tabnam:str, lognam:str, acmode:int, il:object)->int ===
Returns information about the specified logical name.
;parameters
: <code>attr:int</code> attributes controlling the search for the logical name. See '''vms.lnmdef'''
: <code>tabnam:str</code> name of the logical name table or the name of a searchlist logical name
: <code>lognam:str</code> logical name for which information is to be returned
: <code>acmode:int</code> access mode to be used in the translation. See '''vms.psldef'''
: <code>il:object</code> item list, created via [[VMS specific Python modules#new()->object|<code>vms.ile3.new()</code>]]
See '''OpenVMS System Services Reference Manual''' for SYS$TRNLNM.
;returns
:Status code
----
=== dellnm(tabnam:str, lognam:str, acmode:int)->int ===
Deletes all logical names with the specified name.
;parameters
: <code>tabnam:str</code> name of the logical name table or the name of a searchlist logical name
: <code>lognam:str</code> logical name to be deleted
: <code>acmode:int</code> access mode to be used in the delete operation. See '''vms.psldef'''
;returns
:Status code
----
=== device_scan(search_devnam:str, item_list:object, context:int)->list ===
Returns the names of all devices that match a specified set of search criteria.
;parameters
: <code>search_devnam:str</code> name of the device for which <code>device_scan</code> to search
: <code>item_list:object</code> item list specifying search criteria
: <code>context:int</code> value used to indicate the current position of the search. On the initial call it must contain <code>0</code>.
See '''OpenVMS System Services Reference Manual''' for SYS$DEVICE_SCAN
;returns
:The list:
:* <code>int</code> status code of the operation
:* <code>str</code> found device name
:* <code>int</code> context
----
=== uicstr(uic:int, flags:int)->list ===
Converts UIC to a string.
;parameters
: <code>uic:int</code> UIC
: <code>flags:int</code>
:* <code>0</code> - use "!%I" SYS$FAO format
:* <code>1</code> - use "!%U" SYS$FAO format
;returns
:The list:
:* <code>int</code> status code of the operation
:* <code>str</code> UIC string
----
=== getdvi(dev_nam:str, item_list:object)->int ===
Returns information related to the primary and secondary device characteristics of an I/O device.
;parameters
: <code>dev_nam:str</code> the name of the device for which information is to be returned
: <code>item_list:object</code> item list specifying which information about the device is to be returned.
See '''OpenVMS System Services Reference Manual''' for SYS$GETDVI
;returns
:Status code
----
=== getjpi(pid:int, pnam:str, item_list:object)->list ===
Returns information about one or more processes of the system or across the OpenVMS Cluster system.
;parameters
: <code>pid:int</code> process identification
: <code>pnam:str</code> name of the process
: <code>item_list:object</code> item list specifying which information about the process or processes is to be returned
See '''OpenVMS System Services Reference Manual''' for SYS$GETJPI
;returns
:The list:
:* <code>int</code> status code of the operation
:* <code>int</code> process id
----
=== getlki(lki:int, item_list:object)->list ===
Returns information about the lock database on a system.
;parameters
: <code>lki:int</code> identification of the lock (lock ID) information about which needs to be returned
: <code>item_list:object</code> item list specifying the lock information to be returned
See '''OpenVMS System Services Reference Manual''' for SYS$GETLKI
;returns
:The list:
:* <code>int</code> status code of the operation
:* <code>int</code> lock identification
----
=== getmsg(msgid:int, flags:int)->list ===
Returns message text associated with a given message identification code.
;parameters
: <code>msgid:int</code> identification of the message to be retrieved
: <code>flags:int</code> message components to be returned
See '''OpenVMS System Services Reference Manual''' for SYS$GETMSG
;returns
:The list:
:* <code>int</code> status code of the operation
:* <code>str</code> message string
:* <code>int</code> optional information
----
=== getqui(func:int, context:int, item_list:object)->list ===
Returns information about queues and the jobs initiated from these queues.
;parameters
: <code>func:int</code> function code specifying the function that <code>getqui</code> is to perform. See '''vms.quidef'''
: <code>context:int</code> context stream for this call
: <code>item_list:object</code> item list supplying the information to be used by the function
See '''OpenVMS System Services Reference Manual''' for SYS$GETQUI
;returns
:The list:
:* <code>int</code> status code of the operation
:* <code>int</code> context
----
=== getrmi(item_list:object)->int ===
Returns system performance information about the local system.
;parameters
: <code>item_list:object</code> item list specifying which information about the local node is to be returned
See '''OpenVMS System Services Reference Manual''' for SYS$GETRMI
;returns
:Status code
----
=== getsyi(csid:int, node_name:str, item_list:object)->list ===
Returns information about the local system or about other systems in an OpenVMS Cluster system.
;parameters
: <code>csid:int</code> OpenVMS Cluster system identification
: <code>node_name:str</code> name of the node about which information is to be returned
: <code>item_list:object</code> item list specifying which information about the node or nodes to return
See '''OpenVMS System Services Reference Manual''' for SYS$GETSYI
;returns
:The list:
:* <code>int</code> status code of the operation
:* <code>int</code> csid
----
=== gettim()->list ===
Returns the current system time in a 64-bit format.
;parameters
:<code>None</code>
;returns
:The list:
:* <code>int</code> status code of the operation
:* <code>int</code> current system time
----
=== getuai(user_name:str, item_list:object)->int ===
Returns authorization information about the specified user.
;parameters
: <code>user_name:str</code> name of the user to get authorization information for
: <code>item_list:object</code> item list specifying which information to return
See '''OpenVMS System Services Reference Manual''' for SYS$GETUAI
;returns
:Status code
----
=== hiber()->int ===
Allows a process to make itself inactive but to remain known to the system so that it can be interrupted.
;parameters
:<code>None</code>
;returns
:Status code
----
=== schdwk(pid:int, pname:str, time:int)->list ===
Schedules the awakening (restart) of a process that has placed itself in the state of hibernation with the Hibernate service.
;parameters
: <code>pid:int</code> process identification (PID) of the process to be awakened
: <code>pname:str</code> name of the process to be awakened
: <code>time:int</code> time at which the process to be awakened
See '''OpenVMS System Services Reference Manual''' for SYS$SCHDWK
;returns
:The list:
:* <code>int</code> status code of the operation
:* <code>int</code> pid
----
=== add_holder(id:int, holder:int, attrib:int)->int ===
Adds a specified holder record to a target identifier.
;parameters
: <code>id:int</code> target identifier granted to the specified holder
: <code>holder:int</code> holder identifier that is granted access to the target identifier
: <code>attrib:int</code> attributes to be placed in the holder record
See '''OpenVMS System Services Reference Manual''' for SYS$ADD_HOLDER
;returns
:Status code
----
=== add_ident(name:str, id:int, attrib:int)->list ===
Adds the specified identifier to the rights database.
;parameters
: <code>name:str</code> identifier name to be added to the rights database
: <code>id:int</code> identifier to be created
: <code>attrib:int</code> attributes placed in the identifier’s record
See '''OpenVMS System Services Reference Manual''' for SYS$ADD_IDENT
;returns
:The list:
:* <code>int</code> status code of the operation
:* <code>int</code> <code>resid</code>, identifier value assigned by the system
----
=== find_held(holder:int, context:int)->list ===
Returns the identifiers held by the specified holder.
;parameters
: <code>holder:int</code> holder whose identifiers to be found
: <code>context:int</code> context value used when <code>find_held</code> is called repeatedly
See '''OpenVMS System Services Reference Manual''' for SYS$FIND_HELD
;returns
:The list:
:* <code>int</code> status code of the operation
:* <code>int</code> <code>id</code>, identifier value that was found
:* <code>int</code> <code>attrib</code> attributes associated with the holder returned in <code>id</code>
:* <code>int</code> <code>context</code>
----
=== finish_rdb(context:int)->int ===
Deallocates the record stream and clears the context value.
;parameters
: <code>context:int</code> context value to be cleared
;returns
:Status code
----
=== forcex(pid:int, pname:str, code:int)->int ===
Causes an Exit ($EXIT) service call to be issued on behalf of a specified process.
;parameters
: <code>pid:int</code> process identification (PID) of the process to force exit
: <code>pname:str</code> process name of the process that is to force exit
: <code>code:int</code> completion code value to be used as the exit parameter
;returns
:Status code
----
=== rem_holder(id:int, holder:int)->int ===
Deletes the specified holder record from the target identifier’s list of holders.
;parameters
: <code>id:int</code> binary value of the target identifier
: <code>holder:int</code> identifier of the holder being deleted
;returns
:Status code
----
=== rem_ident(id:int)->int ===
Removes the specified identifier record and all its holder records (if any) from the rights database.
;parameters
: <code>id:int</code> binary value of the identifier deleted from rights database
;returns
:Status code
----
=== setuai(user_name:str, item_list:object)->int ===
Modifies the user authorization file (UAF) record for the specified user.
;parameters
: <code>user_name:str</code> name of the user whose UAF record is modified
: <code>item_list:object</code> item list specifying which information from the specified UAF record is to be modified
See '''OpenVMS System Services Reference Manual''' for SYS$SETUAI
;returns
:Status code
----
=== show_intrusion(user_criteria:str, flags:int, context:int)->list ===
Searches for and returns information about records in the intrusion database matching the caller specifications.
;parameters
: <code>user_criteria:str</code> description of an intruder or suspect
: <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
: <code>context:int</code> context information to keep between related calls
See '''OpenVMS System Services Reference Manual''' for SYS$SETUAI
;returns
:The list:
:* <code>int</code> status code of the operation
:* <code>str</code> <code>intruder</code>, user specification of the matched intruder or suspect record in the intrusion database
:* <code>int</code> <code>expires</code>, quadword time format indicating the time when the record will expire
:* <code>int</code> <code>type</code>, the types of the matched record and the status of the suspect
:* <code>int</code> <code>count</code>, number of login failures or break-in attempts
----

== rdb ==
 Wraps the '''Oracle RDB''' functions.
----
=== Attach(dbname:string)->int ===
Attaches to the specified database. The string may specify the full path to the RDB database in OpenVMS format or (more commonly) a logical name pointing to the database.
;parameters
: <code>dbname:string</code> path or logical name
;returns
:Status code:
:* <code>0</code> success
:* <code>-1</code> failed
----
=== CloseCursor(cursor:object)->int ===
Closes the specified cursor.
;parameters
: <code>cursor:object</code> cursor
;returns
:Status code:
:* <code>0</code> success
:* <code>-1</code> failed
----
=== Commit()->int ===
Commits the current database transaction.
;parameters
:<code>None</code>
;returns
:Status code:
:* <code>0</code> success
:* <code>-1</code> failed
----
=== Data(cursor:object, idx:int)->str ===
Given a cursor handle and column index (integer), returns the data value for the specified column for the last fetch operation.
;parameters
: <code>cursor:object</code> cursor
: <code>idx:int</code> index
;returns
:Resulting string
----
=== DeclareCursor(name:str, statement:str)->object ===
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>.
;parameters
: <code>name:str</code> name for the cursor
: <code>statement:str</code> SQL statement
;returns
:Resulting cursor
----
=== Detach()->int ===
Disconnects from the database.
;parameters
<code>None</code>
;returns
:Status code:
:* <code>0</code> success
:* <code>-1</code> failed
----
=== Error()->str ===
Returns a description of the last error.
;parameters
:<code>None</code>
;returns
:Resulting error string
----
=== Exec(sh:object)->int ===
Executes a previously prepared SQL statement.
;parameters
: <code>sh:object</code> prepared SQL statement
;returns
:Status code:
:* <code>0</code> success
:* <code>-1</code> failed
----
=== ExecI(st:str)->int ===
Executes the supplied SQL statement immediately. 
'''Note: the last letter is a capital 'i'
;parameters
: <code>st:str</code> SQL statement
;returns
:Status code:
:* <code>0</code> success
:* <code>-1</code> failed
----
=== Fetch(cursor:object)->int ===
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).
;parameters
: <code>cursor:object</code> cursor
;returns
:Status code:
:* <code>1</code> success
:* <code>0</code> success, end of stream
:* <code>-1</code> failed
----
=== FetchRow(cursor:object)->list ===
Fetches a row of data using the specified cursor handle. The fetched data is returned as an list of strings.
;parameters
: <code>cursor:object</code> cursor
;returns
:The list of strings
----
=== Free(cursor:object)->int ===
Frees resources associated with the supplied cursor handle for a cursor previously declared via <code>DeclareCursor()</code>.
;parameters
: <code>cursor:object</code> cursor
;returns
:Status code:
:* <code>0</code> success
----
=== Ncol(cursor:object)->int ===
Returns the number of columns (values) that would be returned by a fetch for the specified cursor.
;parameters
: <code>cursor:object</code> cursor
;returns
:Number of columns
----
=== OpenCursor(cursor:object)->int ===
Opens a cursor using the supplied (previously declared) cursor handle.
;parameters
: <code>cursor:object</code> cursor
;returns
:Status code:
:* <code>0</code> success
:* <code>-1</code> failed
----
=== Prepare(st:string)->object ===
Prepares an SQL statement and returns a handle for the prepared statement that can be used in subsequent calls to Exec().
;parameters
: <code>st:string</code> SQL statement
;returns
:Resulting prepared statement
----
=== Rollback()->int ===
Rolls back the current database transaction.
;parameters
:<code>None</code>
;returns
:Status code:
:* <code>0</code> success
:* <code>-1</code> failed
----
=== SetReadonly()->int ===
Starts a read-only transaction.
;parameters
:<code>None</code>
;returns
:Status code:
:* <code>0</code> success
:* <code>-1</code> failed
----
=== Sqlcode()->int ===
Returns the SQLCODE for the last database operation.
;parameters
:<code>None</code>
;returns
:Resulting SQL code
----
[[Category:VMS IDE]]

2020-08-31T06:21:05Z

Sergey vorfolomeev:

VMS-Specific Python Modules

2020-08-31T05:26:15Z

Sergey vorfolomeev:

VMS-Specific Python Modules

2020-08-31T05:20:00Z

Sergey vorfolomeev:

VMS-Specific Python Modules

2020-08-31T05:00:00Z

Sergey vorfolomeev: Created page with "VMS specific Python modules. == vms.decc == Provides DECC functionality. === dlopen_test(name:str)->int === Tries to open a shared image. ==== parameters ==== * <code>name:s..."

Project Settings

2020-07-23T04:43:42Z

Sergey vorfolomeev: /* Project Settings Description */

=Project Configuration Example=
[[File:"Project Settings" Example.png|thumb|Project Settings]]
<pre>
{
"project": {
"break": "C",
"builders": "*.{mms,com}",
"exclude": "**/{node_modules,.vscode}/**",
"headers": "*.h",
"listing": "*.lis",
"outdir": "out",
"projectName": "project",
"projectType": "executable",
"resource": "**/resource/**",
"root": "project",
"source": "*.{cpp,c}",
"addLibraries": "sys$library:IMAGELIB.OLB,sys$library:RDBMSGS.OLB",
"addIncludes": "sys$library"
}
}
</pre>

=Project Settings Description=
* <code>'''break'''</code> - Keyboard key to pause debugging in VMS IDE debugger. The extension uses combination <code>CTRL+Key</code> to pause debugging when user press '''Pause''' or <code>F6</code>.
* <code>'''builders'''</code> - Mask for files used for building the project. Default is "*.{mms,com}".
* <code>'''exclude'''</code> - Folders excluded from synchronization with OpenVMS system.
* <code>'''headers'''</code> - Header files. Default is "*.{h,hpp}".
* <code>'''listing'''</code> - Listing files that will be downloaded after the project is built for debugging purpose.
* <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.
* <code>'''projectName'''</code> - Name for the executable file, auto-generated '''MMS''' file for builder, OPT file for linker, and COM file for defining logical names. '''NOTE''': Use one word only; do not use spaces or special characters.
* <code>'''projectType'''</code> - Type of the project. '''Note:''' the building method depends on the type of the project and its dependencies. Available types:
** '''executable''', '''library''' or '''shareable''' for classic languages;
** '''java''', '''kotlin''' or '''scala''' for JVM based projects.
* <code>'''resource'''</code> - Files required for the project, but are not involved in the build process.
* <code>'''root'''</code> - Directory of the project on the remote OpenVMS machine in UNIX format relative to the home folder. Also it may be absolute path if it starts with "/". In this case first word in path is a disk (or logical name). Only default system logical names may be used in '''root''', because login.com is not executed in SFTP session.
* <code>'''source'''</code> - Mask for the source files, e.g. "*.{c,cpp}".
* <code>'''addLibraries'''</code> - list of libraries in ODS-5 format, separated by commas.
* <code>'''addIncludes'''</code> - list of folders in ODS-5 format, separated by commas. 

'''Note: <code>'''root'''</code> must not have trailing "/"

=Adjusting Project Settings=
# Set the <code>'''root'''</code> directory. For example, if the project is located in '''WORK:[USER.DEMOS.SIMPLE]''' and the home directory is '''WORK:[USER]''', set the parameter value to '''demos/simple''' or '''/work/user/demos/simple'''.
# Select the <code>'''projectType'''</code> that you need.
# Specify the <code>'''projectName'''</code>. '''NOTE''': do not use spaces or special characters.
# Check <code>'''builders'''</code>. These files will be synchronized.
# Check <code>'''headers'''</code>. These files will be synchronized and included into the [[Auto-generating MMS|auto-generated MMS]] file as header files. Changing any of them will result in full project rebuild.
# Check <code>'''source'''</code>. These files will be synchronized and included into the [[Auto-generating MMS|auto-generated MMS]] file as source files.
# Check <code>'''resource'''</code>. These files will be synchronized but not included into the [[Auto-generating MMS|auto-generated MMS]] file.
# Adjust the <code>'''exclude'''</code> field value to list the files similar to the described above but not to be synchronized and compiled.
# Check <code>'''listing'''</code>. These files will be downloaded after building the project. Files "*.lis,*.map" are required for debugger.
# If the project depends on already installed libraries, specify the in the <code>'''addLibraries'''</code> and <code>'''addIncludes'''</code>

[https://www.youtube.com/watch?v=Ib1Fo6cG1Vs&list=PLewDXk9a8laO3cAZFPyZ4bbgcKsJ1qgPo Video tutorial: VMS IDE 1 Starting a Project]. In video "Project Settings" shown at 2:40 - 3:37 time period.

[[Category:VMS IDE]]