Stringlist methods syntax: Difference between revisions
m (Automatically generated page update) |
mNo edit summary |
||
Line 55: | Line 55: | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="squareb">[</span><span class="term">%rc</span><span class="literal"> =</span><span class="squareb">]</span> <span class="term">sl</span><span class="literal">:[[AppendSirfactData (Stringlist function)|AppendSirfactData]]</span><span class="literal">(</span> <span class="term" title="String">dataList</span><span class="literal">)</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="squareb">[</span><span class="term">%rc</span><span class="literal"> =</span><span class="squareb">]</span> <span class="term">sl</span><span class="literal">:[[AppendSirfactData (Stringlist function)|AppendSirfactData]]</span><span class="literal">(</span> <span class="term" title="String">dataList</span><span class="literal">)</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="squareb">[</span><span class="term">%count</span><span class="literal"> =</span><span class="squareb">]</span> <span class="term">sl</span><span class="literal">:[[AppendTrace (Stringlist function)|AppendTrace]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="String">parms</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="squareb">[</span><span class="term">%count</span><span class="literal"> =</span><span class="squareb">]</span> <span class="term">sl</span><span class="literal">:[[AppendTrace (Stringlist function)|AppendTrace]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="String">parms</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%string</span><span class="literal"> =</span> <span class="term">sl</span><span class="literal">:[[BinaryProcedureDecode (Stringlist function)|BinaryProcedureDecode]]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%string</span><span class="literal"> =</span> <span class="term">sl</span><span class="literal">:[[BinaryProcedureDecode (Stringlist function)|BinaryProcedureDecode]]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">sl</span><span class="literal">:[[BinaryProcedureEncode (Stringlist subroutine)|BinaryProcedureEncode]]</span><span class="literal">(</span> <span class="term" title="String">string</span><span class="comma">,</span> <span class="squareb">[</span><span class="term" title="Boolean">base64Flag</span><span class="squareb">]</span><span class="literal">)</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">sl</span><span class="literal">:[[BinaryProcedureEncode (Stringlist subroutine)|BinaryProcedureEncode]]</span><span class="literal">(</span> <span class="term" title="String">string</span><span class="comma">,</span> <span class="squareb">[</span><span class="term" title="Boolean">base64Flag</span><span class="squareb">]</span><span class="literal">)</span></p> |
Revision as of 18:47, 6 February 2013
The syntax for each of the Stringlist class methods is shown below.
Square brackets indicate optional elements of the method invocation. See also the notation conventions for methods and the List of Stringlist methods.
[%number =] sl:Add( itemList)
[%number =] sl:AddImage[( [imageName])]
[%number =] sl:AddOrdered( string)
[%number =] sl:AddOrderedUnique( string)
[%number =] sl:AddUnique( string)
[%number =] sl:AddUniqueOrdered( string)
[%rc =] sl:AppendCPCommandOutput( command, [BufferSize= number])
[%rc =] sl:AppendCertificateInfo[( [certificate])]
[%rc =] sl:AppendCertificateRequest( [PrivateKey=] stringlist, - [[Country=] string], [[State=] string], - [[City=] string], - [[Organization=] string], - [[OrganizationalUnit=] string], - [[CommonName=] string])
[%rc =] sl:AppendCertificateRequestInfo( certificateRequest)
[%rc =] sl:AppendClientCertificateRequest( [PublicKey=] stringlist, - [[Country=] string], - [[State=] string], - [[City=] string], - [[Organization=] string], - [[OrganizationalUnit=] string], - [[CommonName=] string], - [[Challenge=] string])
sl:AppendEncryptedSecurityData( sl, [Password=] string, - [[Identifier=] string])
[%count =] sl:AppendFieldImages[( [Image= string], [FirstOccurrence= number], - [MaxOccurrences= number], - [Options= string], [NullValue= string])]
[%count =] sl:AppendFieldValues[( [NameLength= number], [Fieldname= string], - [Options= string])]
sl:AppendGeneratedPrivateKey[( [[Length=] number], [[Exponent=] number], - [[Salt=] string])]
[%rc =] sl:AppendJournalData[( [[StartTime=] string], [[EndTime=] string], - [[Threads=] string], [[Options=] string], - [[Journal=] journal])]
[%rc =] sl:AppendOpenProcedure[( [numLines], [seqIncrement])]
[%number =] sl:AppendPrivateKeyInfo[( [sl], [[Password=] string])]
[%rc =] sl:AppendProcedureList( file, [pname], [accnt], [date])
[%rc =] sl:AppendSignedCertificate( [PrivateKey=] stringlist, - [Request=] stringlist, - [[Signer=] stringlist], - [[StartDate=] string], - [[EndDate=] string], - [[SerialNumber=] number])
[%rc =] sl:AppendSignedClientCertificate( [PrivateKey=] stringlist, - [Request=] stringlist, - [Signer=] stringlist, - [[StartDate=] string], - [[EndDate=] string], - [[SerialNumber=] number])
[%rc =] sl:AppendSirfactCommandOutput( command)
[%rc =] sl:AppendSirfactData( dataList)
[%count =] sl:AppendTrace[( [parms])]
%string = sl:BinaryProcedureDecode
sl:BinaryProcedureEncode( string, [base64Flag])
sl:BindImage( imageName)
[%rc =] sl:ChangeItemLength( itemNum, length)
%rc = sl:CheckCertificate( [PrivateKey=] stringlist, [[Password=] string])
%rc = sl:CheckCertificateRequest( [PrivateKey=] stringlist, - [[Password=] string])
[%outList =] sl:Compare( inList, [syncCount], [pad])
%outList = sl:Copy
sl:CopyImageBinding( boundList)
[%count =] sl:CopyItems( inList, [startItem], [numItems])
%count = sl:Count
%string = sl:CreateLines[( [delim], [AddTrailingDelimiter= boolean])]
%outList = sl:DeepCopy
[%string =] sl:Dequeue
sl:Empty
[%count =] sl:Enqueue( string)
%number = sl:Find( string, [startItem])
%number = sl:FindImageItem( imageItem, [searchValue], [startItem], [operator])
%number = sl:FindImageItemUp( imageItem, [searchValue], [startItem], - [operator])
%number = sl:FindUp( string, [startItem])
%string = sl:FirstItem
sl:GetImage( itemNum, [imageName])
[%count =] sl:Insert( itemNum, itemList)
[%count =] sl:InsertImage( itemNum, [imageName])
%string = sl:Item( itemNum)
%outList = sl:ItemDifferenceList( sl1, itemNum, [separator])
%length = sl:ItemLength( itemNum)
%string = sl:LastItem
%newList = [%(Stringlist):]List( itemList)
%count = sl:ListToItem( strList2, itemNum, [separator])
%itemNum = sl:Locate( string, [[Start=] number], [[StartColumn=] number], - [[EndColumn=] number], [[CaseIndependent=] number], - [[ArbitraryQuote=] number])
%itemNum = sl:LocateUp( string, [[Start=] number], [[StartColumn=] number], - [[EndColumn=] number], [[CaseIndependent=] number], - [[ArbitraryQuote=] number])
%max = %(Stringlist):MaxItemLength
sl:MoveFromId( listId)
sl:MoveToId( listId)
%sl = [%(Stringlist):]New[( [imageName])]
[%rc =] sl:Overlay( itemNum, [startCol], string)
sl:OverlayImageItem( itemNum, imageItem, [value])
sl:ParseLines( string, [delims], [StripTrailingNull= boolean])
%updList = sl:Patch( patchList, [Options= string])
%updList = sl:PatchLines( baseList, [Options= string])
%updString = sl:PatchString( baseString, [Options= string])
%string = sl:PemToString( label, [Occurrence= number]) Throws InvalidPemData
[%string =] sl:Pop
[%count =] sl:Print[( [[NumWidth=] number], [[LenWidth=] number], - [[Start=] number], [[MaxItems=] number])]
[%count =] sl:Push( string)
[%rc =] sl:RegexCapture( string, regex, [Options= string], [Status= %output]) Throws InvalidRegex
[%itemNum =] sl:RegexLocate( regex, [startItem], [Options= string], - [Status= %output], [StartCol= number], - [EndCol= number]) Throws InvalidRegex
[%itemNum =] sl:RegexLocateUp( regex, [startItem], [Options= string], - [Status= %output], [StartCol= number], - [EndCol= number]) Throws InvalidRegex
%outString = sl:RegexReplaceCorresponding( inString, replacementList, - [Options= string], - [Status= %output]) Throws InvalidRegex
[%number =] sl:RegexSplit( inString, regex, [Options= string], - [Status= %output], [Add= regexSplitOutputOptions]) Throws InvalidRegex
%subsetList = sl:RegexSubset( regex, [Options= string], [Status= %output], - [StartCol= number], [EndCol= number]) Throws InvalidRegex
[%count =] sl:RemoveItem( itemNum)
[%rc =] sl:Replace( number, string)
[%rc =] sl:ReplaceImage( itemNum, [imageName])
sl:Sort( sortOrder, [pad]) Throws InvalidSortSpecification
%outList = sl:SortNew( sortOrder, [pad]) Throws InvalidSortSpecification
%outList = sl:Subset( string, [[StartColumn=] number], [[EndColumn=] number], - [[CaseIndependent=] number], [[ArbitraryQuote=] number])
%outList = sl:SubsetImageItem( imageItem, [searchValue], [operator])
sl:UnbindImage
%outList = sl:Update( updList, [%status])