register_file#
- ansys.optislang.core.tcp.server_commands.register_file(uid: str | None = None, ident: str | None = None, local_location: Dict | None = None, action: str | None = None, password: str | None = None) str #
Generate JSON string of register_file command.
- Parameters:
- uid: Optional[str], optional
Uid entry, by default
None
.- ident: Optional[str], optional
Ident, by default
None
.- local_location: Optional[Dict], optional
Dictionary specifying location, e. g. { “split_path”: {“head”: “”, “tail”: “C:/samples_path/result.txt” }, “base_path”: “”, “base_path_mode”: “ABSOLUTE_PATH” }, by default
None
.- action: Optional[str], optional
Action, e. g. “Send”, by default
None
.- password
Optional
[str
],optional
Password, by default
None
.
- Returns:
str
JSON string of register_file command.