StrClb - Revision history

Deguix: Corrected links to LogicLib header file and System plug-in.

2005-12-03T06:18:00Z

Corrected links to LogicLib header file and System plug-in.

â† Older revision		Revision as of 06:18, 3 December 2005
Line 3:		Line 3:
	== Description ==		== Description ==

	'''Requires:''' [[LogicLib]] and [[System]] ~~plugin~~.		'''Requires:''' [[LogicLib header file]] and [[System plug-in]].

	'''Version:''' 2.0.1.		'''Version:''' 2.0.1.

Deguix: Corrected function parameters order.

2005-07-10T11:37:00Z

Corrected function parameters order.

â† Older revision		Revision as of 11:37, 10 July 2005
Line 18:		Line 18:
	or		or
	<highlight-nsis>		<highlight-nsis>
			Push "String"
	Push "Action"		Push "Action"
	~~Push "String"~~
	Call StrClb		Call StrClb
	Pop "ResultVar"		Pop "ResultVar"
Line 67:		Line 67:

	!macro StrClb ResultVar String Action		!macro StrClb ResultVar String Action
			Push "${String}"
	Push "${Action}"		Push "${Action}"
	~~Push "${String}"~~
	Call StrClb		Call StrClb
	Pop "${ResultVar}"		Pop "${ResultVar}"

Deguix: Forgot the initial line ''Function "StrClb"'' in the function's code.

2005-07-10T06:15:04Z

Forgot the initial line ''Function "StrClb"'' in the function's code.

â† Older revision		Revision as of 06:15, 10 July 2005
Line 73:		Line 73:
	!macroend		!macroend

			Function StrClb
	/*After this point:		/*After this point:
	------------------------------------------		------------------------------------------

Deguix: Removed required value indicators for ''Action'' parameter in syntax.

2005-07-10T06:13:38Z

Removed required value indicators for ''Action'' parameter in syntax.

â† Older revision		Revision as of 06:13, 10 July 2005
Line 14:		Line 14:

	<highlight-nsis>		<highlight-nsis>
	${StrClb} "ResultVar" "String" "Action~~(\|>\|<\|<>)~~"		${StrClb} "ResultVar" "String" "Action"
	</highlight-nsis>		</highlight-nsis>
	or		or
	<highlight-nsis>		<highlight-nsis>
	Push "Action~~(\|>\|<\|<>)~~"		Push "Action"
	Push "String"		Push "String"
	Call StrClb		Call StrClb

Deguix: "swaping" -> "swap".

2005-07-10T06:12:12Z

"swaping" -> "swap".

â† Older revision		Revision as of 06:12, 10 July 2005
Line 7:		Line 7:
	'''Version:''' 2.0.1.		'''Version:''' 2.0.1.

	Makes an action with the clipboard. This function can clean the clipboard, set or get a value to/from clipboard or ~~swaping~~ values.		Makes an action with the clipboard. This function can clean the clipboard, set or get a value to/from clipboard or swap values.

	== How To Use ==		== How To Use ==

Deguix: Version: 2.0.1.

2005-07-10T06:11:39Z

Version: 2.0.1.

New page

{{PageAuthor|deguix}}

== Description ==

'''Requires:''' [[LogicLib]] and [[System]] plugin.

'''Version:''' 2.0.1.

Makes an action with the clipboard. This function can clean the clipboard, set or get a value to/from clipboard or swaping values.

== How To Use ==

=== Syntax ===

<highlight-nsis>
${StrClb} "ResultVar" "String" "Action(|>|<|<>)"
</highlight-nsis>
or
<highlight-nsis>
Push "Action(|>|<|<>)"
Push "String"
Call StrClb
Pop "ResultVar"
</highlight-nsis>

=== Parameters ===

; ResultVar
: Variable where the value from the clipboard is retrieved when ''Action'' is "<" or "<>". If the clipboard is empty or filled with non-recognizable data as text at the time, an empty value is returned.

:<span style="color: red;">'''WARNING:'''</span> This value requires a variable, even when it's not needed. In this occasion, the return value is an empty string. You should reserve a variable for this occasion.

; String
: String to set to the clipboard when ''Action'' is ">" or "<>".

:'''NOTE:''' The value will always be considered text.

; Action
: Specifies an action to do with the clipboard. The value of this parameter can be the following:
:;empty value
::Clear clipboard.
:;>
::Set the value from the ''String'' parameter to the clipboard.
:;<
::Get the value from the clipboard to ''ResultVar'' parameter.
:;<>
::Swap the value from the ''String'' parameter with the clipboard's, which is returned to ''ResultVar'' parameter.

=== Example ===

<highlight-nsis>
${StrClb} $0 "This is just an example" ">"
${StrClb} $0 "" "<"
;$0 = "This is just an example"

${StrClb} $0 "This is another example" "<>"
;$0 = "This is just an example"

${StrClb} $0 "" ""
;$0 = ""
</highlight-nsis>

== Function Code ==

<highlight-nsis>
!define StrClb "!insertmacro StrClb"

!macro StrClb ResultVar String Action
Push "${Action}"
Push "${String}"
Call StrClb
Pop "${ResultVar}"
!macroend

/*After this point:
------------------------------------------
$0 = String (input)
$1 = Action (input)
$2 = Lock/Unlock (temp)
$3 = Temp (temp)
$4 = Temp2 (temp)*/

;Get input from user

Exch $1
Exch
Exch $0
Exch
Push $2
Push $3
Push $4

StrCpy $2 ""
StrCpy $3 ""
StrCpy $4 ""

;Open the clipboard to do the operations the user chose (kichik's fix)
System::Call 'user32::OpenClipboard(i $HWNDPARENT)'

${If} $1 == ">" ;Set

;Step 1: Clear the clipboard
System::Call 'user32::EmptyClipboard()'

;Step 2: Allocate global heap
StrLen $2 $0
IntOp $2 $2 + 1
System::Call 'kernel32::GlobalAlloc(i 2, i r2) i.r2'

;Step 3: Lock the handle
System::Call 'kernel32::GlobalLock(i r2) i.r3'

;Step 4: Copy the text to locked clipboard buffer
System::Call 'kernel32::lstrcpyA(i r3, t r0)'

;Step 5: Unlock the handle again
System::Call 'kernel32::GlobalUnlock(i r2)'

;Step 6: Set the information to the clipboard
System::Call 'user32::SetClipboardData(i 1, i r2)'

StrCpy $0 ""

${ElseIf} $1 == "<" ;Get

;Step 1: Get clipboard data
System::Call 'user32::GetClipboardData(i 1) i .r2'

;Step 2: Lock and copy data (kichik's fix)
System::Call 'kernel32::GlobalLock(i r2) t .r0'

;Step 3: Unlock (kichik's fix)
System::Call 'kernel32::GlobalUnlock(i r2)'

${ElseIf} $1 == "<>" ;Swap

;Step 1: Get clipboard data
System::Call 'user32::GetClipboardData(i 1) i .r2'

;Step 2: Lock and copy data (kichik's fix)
System::Call 'kernel32::GlobalLock(i r2) t .r4'

;Step 3: Unlock (kichik's fix)
System::Call 'kernel32::GlobalUnlock(i r2)'

;Step 4: Clear the clipboard
System::Call 'user32::EmptyClipboard()'

;Step 5: Allocate global heap
StrLen $2 $0
IntOp $2 $2 + 1
System::Call 'kernel32::GlobalAlloc(i 2, i r2) i.r2'

;Step 6: Lock the handle
System::Call 'kernel32::GlobalLock(i r2) i.r3'

;Step 7: Copy the text to locked clipboard buffer
System::Call 'kernel32::lstrcpyA(i r3, t r0)'

;Step 8: Unlock the handle again
System::Call 'kernel32::GlobalUnlock(i r2)'

;Step 9: Set the information to the clipboard
System::Call 'user32::SetClipboardData(i 1, i r2)'

StrCpy $0 $4
${Else} ;Clear

;Step 1: Clear the clipboard
System::Call 'user32::EmptyClipboard()'

StrCpy $0 ""
${EndIf}

;Close the clipboard
System::Call 'user32::CloseClipboard()'

/*After this point:
------------------------------------------
$0 = ResultVar (output)*/

;Return result to user
Pop $4
Pop $3
Pop $2
Pop $1
Exch $0
FunctionEnd
</highlight-nsis>

== Versions History ==

;2.0.1
*Fixed the return of text when ''Action'' parameter value was equal to "<>".

== Credits ==
Author: Diego Pedroso ([[User:deguix|deguix]])<br>
Based on [[Copy to, or get from Windows Clipboard|CopyToClipboard]] and [[Copy to, or get from Windows Clipboard|CopyFromClipboard]] functions.

[[Category:String Functions]]