---
title: "Ice.Plugin.*"
url: https://docs.zeroc.com/ice/3.8/property-reference/ice-plugin-properties
language: ruby
docs_index: https://docs.zeroc.com/llms.txt
---

> For an index of every page, see [llms.txt](https://docs.zeroc.com/llms.txt).

# Ice.Plugin.\*

Programming language: Ruby. Other languages: [C++](https://docs.zeroc.com/ice/3.8/property-reference/ice-plugin-properties/cpp.md), [C#](https://docs.zeroc.com/ice/3.8/property-reference/ice-plugin-properties/csharp.md), [Java](https://docs.zeroc.com/ice/3.8/property-reference/ice-plugin-properties/java.md), [JavaScript](https://docs.zeroc.com/ice/3.8/property-reference/ice-plugin-properties/js.md), [MATLAB](https://docs.zeroc.com/ice/3.8/property-reference/ice-plugin-properties/matlab.md), [PHP](https://docs.zeroc.com/ice/3.8/property-reference/ice-plugin-properties/php.md), [Python](https://docs.zeroc.com/ice/3.8/property-reference/ice-plugin-properties/python.md), [Swift](https://docs.zeroc.com/ice/3.8/property-reference/ice-plugin-properties/swift.md).

## Ice.Plugin.*name*

`Ice.Plugin.name=path[,version]:function [args]`

Defines a C++ plug-in to be installed during communicator initialization. The `path` and optional `version` components are used to construct the path name of a DLL or shared library. If no version is supplied, the Ice version is used. The `function` component is the name of a function with C linkage. For example, the entry point `MyPlugin,38:create` would imply a shared library name of `libMyPlugin.so.38` on Linux, `libMyPlugin.38.dylib` on macOS, and `MyPlugin38.dll` on Windows. Furthermore, if Ice is built on Windows with debugging, a `d` is automatically appended to the version (for example, `MyPlugin38d.dll`). On macOS, if the `.dylib` cannot be loaded, Ice also tries `libMyPlugin.38.so` and `libMyPlugin.38.bundle`.

Arguments of the form `--name.X=Y` set the property `name.X` to `Y` and are removed from the argument list passed to the factory, where `name` is the plug-in name. For example, `--MyPlugin.Mode=fast` sets `MyPlugin.Mode=fast`.

Ice passes the remaining arguments to the entry point function. For example:

```config
Ice.Plugin.MyPlugin=MyFactory,38:create arg1 arg2
```

Whitespace separates the arguments, and any arguments that contain whitespace must be enclosed in quotes.

The `path` component may optionally contain a relative or absolute path name, indicated by the presence of a path separator (`/` or `\`). In this case, the last component of the path is used to construct the version-specific name of the shared library or DLL. Consider this example:

```config
Ice.Plugin.MyPlugin=./MyFactory,38:create arg1 arg2
```

The use of a relative path means the Ice runtime looks in the current working directory for `libMyFactory.so.38` on Linux, `libMyFactory.38.dylib` on macOS, or `MyFactory38.dll` on Windows.

If the `path` component contains spaces, the entire entry point must be enclosed in quotes:

```config
Ice.Plugin.MyPlugin="C:\Program Files\MyPlugin\MyFactory,38:create" arg1 arg2
```

If the `path` component does not include a leading path name, Ice delegates to the operating system to locate the shared library or DLL, which typically means that the plug-in can reside in any of the directories in your shared library or DLL search path.

Ice includes the IceDiscovery and IceLocatorDiscovery plug-in factories in this mapping. A non-empty value for either property enables the corresponding built-in factory; the entry-point token is ignored:

```config
Ice.Plugin.IceDiscovery=1
Ice.Plugin.IceLocatorDiscovery=1
```

Ice passes the remaining arguments after the first token to the factory. Ice creates these built-in plug-ins before dynamically loaded plug-ins.
