Skip to content

Commit d309937

Browse files
dotps1dotps1
committed
Add help for Copy-WinSCPItem.
1 parent d13c883 commit d309937

File tree

4 files changed

+30
-28
lines changed

4 files changed

+30
-28
lines changed

‎.DS_Store‎

-8 KB
Binary file not shown.

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Local Repository Files To Ignore:
22
winscp.ini
3-
.DS_Stores
3+
.DS_Store
44

55
VSCode files to ignore:
66
.vscode

‎Help/Copy-WinSCPItem.md‎

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Copy-WinSCPItem
99

1010
## SYNOPSIS
11-
{{Fill in the Synopsis}}
11+
Duplicates remote file to another remote directory or name.
1212

1313
## SYNTAX
1414

@@ -18,16 +18,14 @@ Copy-WinSCPItem -WinSCPSession <Session> [-Path] <String[]> [[-Destination] <Str
1818
```
1919

2020
## DESCRIPTION
21-
{{Fill in the Description}}
21+
Duplicates remote file to another remote directory or name.
2222

2323
## EXAMPLES
2424

2525
### Example 1
26-
```powershell
27-
PS C:\> {{ Add example code here }}
2826
```
29-
30-
{{ Add example description here }}
27+
PS C:\> Copy-WinSCPItem -Path "./Folder/File.txt" -Destination "./NewFolder/File.txt"
28+
```
3129

3230
## PARAMETERS
3331

@@ -47,7 +45,7 @@ Accept wildcard characters: False
4745
```
4846
4947
### -Destination
50-
{{Fill Destination Description}}
48+
Full path to new location and name to duplicate the file to.
5149
5250
```yaml
5351
Type: String
@@ -62,7 +60,7 @@ Accept wildcard characters: False
6260
```
6361
6462
### -Force
65-
{{Fill Force Description}}
63+
Overwrite the destination if it exists.
6664
6765
```yaml
6866
Type: SwitchParameter
@@ -77,7 +75,7 @@ Accept wildcard characters: False
7775
```
7876
7977
### -PassThru
80-
{{Fill PassThru Description}}
78+
Gets the RemoteFileInfo object from the new path.
8179
8280
```yaml
8381
Type: SwitchParameter
@@ -92,7 +90,7 @@ Accept wildcard characters: False
9290
```
9391
9492
### -Path
95-
{{Fill Path Description}}
93+
Full path to remote file to duplicate.
9694
9795
```yaml
9896
Type: String[]
@@ -123,7 +121,7 @@ Accept wildcard characters: False
123121
```
124122
125123
### -WinSCPSession
126-
{{Fill WinSCPSession Description}}
124+
It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.
127125
128126
```yaml
129127
Type: Session
@@ -153,5 +151,5 @@ System.String[]
153151
154152
## RELATED LINKS
155153
156-
[https://github.com/dotps1/WinSCP/wiki/Copy-WinSCPItem](https://github.com/dotps1/WinSCP/wiki/Copy-WinSCPItem)
154+
[WinSCP reference:](https://winscp.net/eng/docs/library_session_duplicatefile)
157155

‎WinSCP/en-US/WinSCP-Help.xml‎

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -122,19 +122,19 @@ PS C:\&gt; Remove-WinSCPSession</dev:code>
122122
<command:verb>Copy</command:verb>
123123
<command:noun>WinSCPItem</command:noun>
124124
<maml:description>
125-
<maml:para>{{Fill in the Synopsis}}</maml:para>
125+
<maml:para>Duplicates remote file to another remote directory or name.</maml:para>
126126
</maml:description>
127127
</command:details>
128128
<maml:description>
129-
<maml:para>{{Fill in the Description}}</maml:para>
129+
<maml:para>Duplicates remote file to another remote directory or name.</maml:para>
130130
</maml:description>
131131
<command:syntax>
132132
<command:syntaxItem>
133133
<maml:name>Copy-WinSCPItem</maml:name>
134134
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none">
135135
<maml:name>Path</maml:name>
136136
<maml:Description>
137-
<maml:para>{{Fill Path Description}}</maml:para>
137+
<maml:para>Full path to remote file to duplicate.</maml:para>
138138
</maml:Description>
139139
<command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>
140140
<dev:type>
@@ -146,7 +146,7 @@ PS C:\&gt; Remove-WinSCPSession</dev:code>
146146
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
147147
<maml:name>Destination</maml:name>
148148
<maml:Description>
149-
<maml:para>{{Fill Destination Description}}</maml:para>
149+
<maml:para>Full path to new location and name to duplicate the file to.</maml:para>
150150
</maml:Description>
151151
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
152152
<dev:type>
@@ -169,7 +169,7 @@ PS C:\&gt; Remove-WinSCPSession</dev:code>
169169
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
170170
<maml:name>Force</maml:name>
171171
<maml:Description>
172-
<maml:para>{{Fill Force Description}}</maml:para>
172+
<maml:para>Overwrite the destination if it exists.</maml:para>
173173
</maml:Description>
174174
<dev:type>
175175
<maml:name>SwitchParameter</maml:name>
@@ -180,7 +180,7 @@ PS C:\&gt; Remove-WinSCPSession</dev:code>
180180
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
181181
<maml:name>PassThru</maml:name>
182182
<maml:Description>
183-
<maml:para>{{Fill PassThru Description}}</maml:para>
183+
<maml:para>Gets the RemoteFileInfo object from the new path.</maml:para>
184184
</maml:Description>
185185
<dev:type>
186186
<maml:name>SwitchParameter</maml:name>
@@ -202,7 +202,7 @@ PS C:\&gt; Remove-WinSCPSession</dev:code>
202202
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
203203
<maml:name>WinSCPSession</maml:name>
204204
<maml:Description>
205-
<maml:para>{{Fill WinSCPSession Description}}</maml:para>
205+
<maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para>
206206
</maml:Description>
207207
<command:parameterValue required="true" variableLength="false">Session</command:parameterValue>
208208
<dev:type>
@@ -229,7 +229,7 @@ PS C:\&gt; Remove-WinSCPSession</dev:code>
229229
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
230230
<maml:name>Destination</maml:name>
231231
<maml:Description>
232-
<maml:para>{{Fill Destination Description}}</maml:para>
232+
<maml:para>Full path to new location and name to duplicate the file to.</maml:para>
233233
</maml:Description>
234234
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
235235
<dev:type>
@@ -241,7 +241,7 @@ PS C:\&gt; Remove-WinSCPSession</dev:code>
241241
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
242242
<maml:name>Force</maml:name>
243243
<maml:Description>
244-
<maml:para>{{Fill Force Description}}</maml:para>
244+
<maml:para>Overwrite the destination if it exists.</maml:para>
245245
</maml:Description>
246246
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
247247
<dev:type>
@@ -253,7 +253,7 @@ PS C:\&gt; Remove-WinSCPSession</dev:code>
253253
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
254254
<maml:name>PassThru</maml:name>
255255
<maml:Description>
256-
<maml:para>{{Fill PassThru Description}}</maml:para>
256+
<maml:para>Gets the RemoteFileInfo object from the new path.</maml:para>
257257
</maml:Description>
258258
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
259259
<dev:type>
@@ -265,7 +265,7 @@ PS C:\&gt; Remove-WinSCPSession</dev:code>
265265
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none">
266266
<maml:name>Path</maml:name>
267267
<maml:Description>
268-
<maml:para>{{Fill Path Description}}</maml:para>
268+
<maml:para>Full path to remote file to duplicate.</maml:para>
269269
</maml:Description>
270270
<command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>
271271
<dev:type>
@@ -289,7 +289,7 @@ PS C:\&gt; Remove-WinSCPSession</dev:code>
289289
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
290290
<maml:name>WinSCPSession</maml:name>
291291
<maml:Description>
292-
<maml:para>{{Fill WinSCPSession Description}}</maml:para>
292+
<maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para>
293293
</maml:Description>
294294
<command:parameterValue required="true" variableLength="false">Session</command:parameterValue>
295295
<dev:type>
@@ -327,17 +327,21 @@ PS C:\&gt; Remove-WinSCPSession</dev:code>
327327
<command:examples>
328328
<command:example>
329329
<maml:title>-------------------------- Example 1 --------------------------</maml:title>
330-
<dev:code>PS C:\&gt; {{ Add example code here }}</dev:code>
330+
<dev:code>PS C:\&gt; Copy-WinSCPItem -Path "./Folder/File.txt" -Destination "./NewFolder/File.txt"</dev:code>
331331
<dev:remarks>
332-
<maml:para>{{ Add example description here }}</maml:para>
332+
<maml:para></maml:para>
333333
</dev:remarks>
334334
</command:example>
335335
</command:examples>
336336
<command:relatedLinks>
337337
<maml:navigationLink>
338-
<maml:linkText>https://github.com/dotps1/WinSCP/wiki/Copy-WinSCPItem</maml:linkText>
338+
<maml:linkText>Online Version:</maml:linkText>
339339
<maml:uri>https://github.com/dotps1/WinSCP/wiki/Copy-WinSCPItem</maml:uri>
340340
</maml:navigationLink>
341+
<maml:navigationLink>
342+
<maml:linkText>WinSCP reference:</maml:linkText>
343+
<maml:uri>https://winscp.net/eng/docs/library_session_duplicatefile</maml:uri>
344+
</maml:navigationLink>
341345
</command:relatedLinks>
342346
</command:command>
343347
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

0 commit comments

Comments
 (0)