powershell: run code when importing module

Question

I have developed a powershell module in C#, implemented a few commands.

How can I execute C# code in this module when it's imported by Powershell?

You want you binary(c#) powershell-module to run some code when it's imported? Unclear question. Have you tried anything yet? — Frode F.
– Frode F., Commented Jan 30, 2013 at 18:34
Correct, I want to execute C# code in my module when it's imported by powershell. I want to do some initiation stuff. And "when it's imported by powershell" -> when executing command: Import-Module .\MyModule.dll — Mr Dudemeister
– Mr Dudemeister, Commented Jan 30, 2013 at 18:39

Keith Hill · Accepted Answer · 2013-01-30 18:49:12Z

6

Create a module manifest with the ModuleToProcess (or RootModule in V3) field set to the PSM1 file and the NestedModules set to the DLL e.g.:

RootModule         = 'Pscx.psm1'
NestedModules      = 'Pscx.dll'

This is what we do in the PowerShell Community Extensions where we do the same thing - fire up a script first. You can see our PSD1 file here.

answered Jan 30, 2013 at 18:49

Keith Hill

204k44 gold badges370 silver badges377 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Mr Dudemeister Over a year ago

Do I need to sign the assembly with signtool, or how does the psd1 file become embedded into the dll file?

Keith Hill Over a year ago

You don't embed the PSD1 in the DLL. You ship a module as a collection of files in a folder e.g. PSCX\pscx.psd1, PSCX\pscx.psm1, PSCX\pscx.dll, etc. And you don't have to Authenticode sign anything.

Petr Over a year ago

I use exactly this approach, but then the module auto-loading does not work. My users must explicitly run Import-Module before first use. When I keep RootModule empty, auto-loading just works. Do you have the same problem?

iQueue · Accepted Answer · 2016-01-29 06:34:58Z

1

I'm also writing a binary cmdLet in .NET. I have found that if you create a class that inherits from at least DriveCmdletProvider, that class can implement InitializeDefaultDrives.

This method will get call when import-module is called on your DLL.

You could use this 'feature' to stand up some session (or module session) data.

answered Jan 29, 2016 at 6:34

iQueue

3562 silver badges7 bronze badges

Comments

Christopher Douglas · Accepted Answer · 2013-01-30 18:28:08Z

0

This is a very basic solution, simply replace code within the {} with your source. (my test below)

add-type 'public class c{public const string s="Hello World";}';[c]::s

enjoy

answered Jan 30, 2013 at 18:28

Christopher Douglas

1,5802 gold badges9 silver badges16 bronze badges

4 Comments

Mr Dudemeister Over a year ago

Are you suggesting to explicit execute a function after import?

Christopher Douglas Over a year ago

I'm not a c# developer by any stretch of the imagination. But when I write my powershell modules when you import the module the code not wrapped in a function or workflow is executed as soon as it loads. I cannot be sure this is the case with a C# module.

Mr Dudemeister Over a year ago

I don't think there's anything that corresponds to trailing script code in a C# module.

Christopher Douglas Over a year ago

Keith Hill has it on the nose, ModuleToProcess, my first logical step would have been script to process, this is an excerpt from my Module Manifest. # Script files (.ps1) that are run in the caller's environment prior to importing this module. # ScriptsToProcess = @()

Collectives™ on Stack Overflow

powershell: run code when importing module

3 Answers 3

3 Comments

Comments

4 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

3 Comments

Comments

4 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related