Struct sap_scripting::types::GuiConnection

pub struct GuiConnection { /* private fields */ }

A GuiConnection represents the connection between SAP GUI and an application server. Connections can be opened from SAP Logon or from GuiApplication’s openConnection and openConnectionByConnectionString methods. GuiConnection extends the GuiContainer Object. The type prefix for GuiConnection is con, the name is con plus the connection number in square brackets.

Implementations

impl GuiConnection

pub fn close_connection(&self) -> Result<()>

This method closes a connection along with all its sessions.

pub fn close_session<S>(&self, id: S) -> Result<()>where S: AsRef<str>,

A session can be closed by calling this method of the connection. Closing the last session of a connection will close the connection, too.

The parameter “Id” must contain the id of the session to close (like “/app/con[0]/ses[0]”).

Trait Implementations

impl GuiComponentMethods<GuiConnection> for GuiConnection

fn container_type(&self) -> Result<bool>

This property is TRUE, if the object is a container and therefore has the Children property.

fn id(&self) -> Result<String>

An object id is a unique textual identifier for the object. It is built in a URLlike formatting, starting at the GuiApplication object and drilling down to the respective object.

fn name(&self) -> Result<String>

The name property is especially useful when working with simple scripts that only access dynpro fields. In that case a field can be found using its name and type information, which is easier to read than a possibly very long id. However, there is no guarantee that there are no two objects with the same name and type in a given dynpro.

fn kind(&self) -> Result<String>

The type information of GuiComponent can be used to determine which properties and methods an object supports. The value of the type string is the name of the type taken from this documentation.

fn kind_as_number(&self) -> Result<i64>

While the Type property is a string value, the TypeAsNumber property is a long value that can alternatively be used to identify an object’s type . It was added for better performance in methods such as FindByIdEx. Possible values for this property are taken from the GuiComponentTypeenumeration.

impl GuiContainerMethods<GuiConnection> for GuiConnection

fn find_by_id<S>(&self, id: S) -> Result<SAPComponent>where S: AsRef<str>,

Search through the object’s descendants for a given id. If the parameter is a fully qualified id, the function will first check if the container object’s id is a prefix of the id parameter. If that is the case, this prefix is truncated. If no descendant with the given id can be found the function raises an exception.

fn children(&self, n: u32) -> Result<GuiSession>

This collection contains all direct children of the object.

impl HasDispatch<GuiConnection> for GuiConnection

fn get_idispatch(&self) -> &IDispatch

Get the IDispatch object for low-level access to this component.