{"id":6196,"date":"2022-03-09T09:42:00","date_gmt":"2022-03-09T07:42:00","guid":{"rendered":"https:\/\/lazyadmin.nl\/?p=6196"},"modified":"2022-03-08T17:42:53","modified_gmt":"2022-03-08T15:42:53","slug":"substring","status":"publish","type":"post","link":"https:\/\/lazyadmin.nl\/powershell\/substring\/","title":{"rendered":"How-to use Substring in PowerShell"},"content":{"rendered":"\n

When you want to extract a part of a string in PowerShell we can use the Substring() method. This method allows us to specify the start and length of the substring that we want to extract from a string.<\/p>\n\n\n\n

In this article, I will explain how the Substring method works, and show you a couple of examples of how to get parts of a string using the startIndex and\/or length function.<\/p>\n\n\n\n

Using the Substring Method in PowerShell<\/h2>\n\n\n\n

The Substring method can be used on any string object in PowerShell. This can be a literal string or any variable of the type string.<\/p>\n\n\n\n

To use the method we will need to specify the starting point of the string that we want to extract. Optionally we can specify the length (number of characters), that we want to extract.<\/p>\n\n\n\n

Substring(startIndex, length)<\/pre>\n\n\n\n
Tip<\/p>Keep in mind that a string starts at position 0 and not 1<\/cite><\/blockquote>\n\n\n\n
This method is best explained with the help of examples, so let’s start with the following famous string “hello world”. To extract only the word world<\/em> from the string we can use the following command:<\/p>\n\n\n\n
\"Hello World\".Substring(6)\n\n# Result\nWorld<\/pre>\n\n\n\n
We have only specified the start point of the substring, 6. This way the method will extract all characters starting from position 6 of the string.<\/p>\n\n\n\n
To explain the position of each character a bit better, I have numbered the position below each letter of the string. As you can see, position 6 is the letter W<\/strong>.<\/p>\n\n\n\n
Hello World\n012345678910<\/pre>\n\n\n\n
If we only want to extract the word Hello<\/em> from the string, then we need to specify the startIndex of 0 and a length of 5 characters:<\/p>\n\n\n\n
\"Hello World\".Substring(0,5)\n\n# Result\nHello<\/pre>\n\n\n\n
Working with Dynamic Strings<\/h3>\n\n\n\n
When working with dynamic strings you don’t always know the length of the string. For this, we can use the string length function inside the substring method.<\/p>\n\n\n\n
Let’s say we have a folder with log files from which we want to extract the filenames without the extension. The filename itself can have different lengths, but the extension, in this case, is 3 letters and a dot.<\/p>\n\n\n\n
So the keep only the filenames we can get the length of the filename and subtract 4 characters from it:<\/p>\n\n\n\n
$filename = \"la-ams-file02-log-1.log\"\n\n$filename.Substring(0, $filename.Length - 4)\n\n# Result\nla-ams-file02-log-1<\/pre>\n\n\n\n
We can also use this the other way around to get only the extensions from the filenames. We determine the start position based on the length of the filename, and specify a length of 3 characters:<\/p>\n\n\n\n
$filename = \"la-ams-file02-log-1.log\"\n$filename.Substring($filename.Length - 3, 3)\n\n# Result\nlog<\/pre>\n\n\n\n
In this case, we actually don’t need to specify the length of the substring to return (3), because we can simply return the remaining characters:<\/p>\n\n\n\n
$filename.Substring($filename.Length - 3)\n\n# Result\nlog<\/pre>\n\n\n\n
Using IndexOf in Substring<\/h3>\n\n\n\n
When working with dynamics string lengths you sometimes want to extract a part in the middle of the string. The challenge then is to find\/calculate the exact starting position for the substring method.<\/p>\n\n\n\n
One option to do this is to use IndexOf. This method allows you to find the position of a character or string inside a string.<\/p>\n\n\n\n
Let’s go back to our log files example. I have added a totally useless date format to it, with inconsistent length. To get only the date from the name of the log files, we can use the IndexOf()<\/code> method.<\/p>\n\n\n\n
We are going to search in the string for the unique part before the date -log<\/code>. The IndexOf method will return the starting position of the string or character that you searched for, so in this case, we will need to add 4 characters to it:<\/p>\n\n\n\n
$files = @(\n    'la-ams-ad01-log-202223.log',\n    'la-ams-ad01-log-2022113.log',\n    'la-osl-ad01-log-2022113.log',\n    'la-osl-file01-log-202214.log'\n)\n$files | Foreach {\n    # Get the position of the substring 'log-' in each filename and add 4 to this position.\n    $part = $_.Substring($_.IndexOf('log-') + 4)\n    # Returns 202223.log for example\n \n    # Remove the extension from the substring\n    $date = $part.Substring(0, $part.Length - 4)\n    write-host $date\n    # Returns 202223 for example\n}\n<\/pre>\n\n\n\n
In this particular case, you could also use the method LastIndexOf()<\/code> in the hyphens in the names of the files:<\/p>\n\n\n\n
$files | Foreach {\n    $part = $_.Substring($_.LastIndexOf('-') + 1)\n    write-host $part\n\n    $date = $part.Substring(0, $part.Length - 4)\n    write-host $date\n}<\/pre>\n\n\n\n
Wrapping Up<\/h2>\n\n\n\n
When working with strings in PowerShell you will probably be using the substring method quite a lot. Keep in mind that you can always combine the substring method with other string operators like split or replace<\/a>.<\/p>\n\n\n\n
I hope you found this article useful, if you have any questions, just drop a comment below.<\/p>\n