Framework EDI Reference. Methods and Properties
mailMessage. GetHeaderTypeParameters

Gets a header having a Parameters type.

Syntax:

• Set <oParameters> = object.GetHeaderTypeParameters (<sFieldName>)

Parameter:

• sFieldName – Field name of the header that is of Parameters type.

Returns:

If successful an object of FREDI.mailParameters is returned otherwise NULL or empty.

Remarks:

If the header specified by the field name is not a Parameters type the operation fails and returns NULL.

Example

Dim oEdiDoc As Fredi.ediDocument
Dim oMailDocument As Fredi.mailDocument
Dim oSubjMsg As Fredi.mailMessage
Dim oParameters As Fredi.mailParameters
Dim oParam As Fredi.mailParameter
Dim sParamList As String
Dim i As Integer

' Create instance of Framework EDI.
Set oEdiDoc = New Fredi.ediDocument

' Get internet mail document object
Set oMailDocument = oEdiDoc.GetMailDocument

' First add definition of header of parameters type.
oMailDocument.AddDefinedHeader "ParamList", HeaderType_Parameters, Requirement_Optional

' Load EDI document normally.
oMailDocument.Load App.Path & "\SampleMail.TXT"

' Get subject document.
Set oSubjMsg = oMailDocument.GetMessage

' Get the parameters header type.
Set oParameters = oSubjMsg.GetHeaderTypeParameters("ParamList")

sParamList = ""

For i = 1 To oParameters.Count

Set oParam = oParameters.GetParameter(i)

sParamList = sParamList & "Parameter (" & oParam.Name & ") = " & oParam.Value
sParamList = sParamList & vbCrLf

Next

MsgBox sParamList

Samples

• M_GetHeaderTypeParameters.zip