Sndry::GetDetail

Gets an accounting detail from the document.

VARIANT_BOOL GetDetail (
    SHORT sIndex,
    VARIANT* pvAmountDocC,
    VARIANT* pvQuantity,
    VARIANT* pvValue1,
    VARIANT* pvAccount,
    VARIANT* pvRemark,
    VARIANT* pvText1,
    VARIANT* pvAmountDetC,
    VARIANT* pvDetC,
    VARIANT* pvTickSysNum
)

Parameters

sIndex

[in] The index of the detail, starting from 0.

pvAmountDocC

[out] Returns a VARIANT, subtype DOUBLE, containing the amount (in document currency) of the detail.

pvQuantity

[out] Returns a VARIANT, subtype DOUBLE, containing the quantity of the detail.

pvValue1

[out] Returns a VARIANT, subtype DOUBLE, containing the free value of the detail.

pvAccount

[out] Returns a VARIANT, subtype BSTR, containing the general account of the detail.

pvRemark

[out] Returns a VARIANT, subtype BSTR, containing the remark of the detail.

pvText1

[out] Returns a VARIANT, subtype BSTR, containing the free text of the detail.

pvAmountDetC

[out] Returns a VARIANT, subtype DOUBLE, containing the amount (in detail currency) of the detail.

pvDetC

[out] Returns a VARIANT, subtype BSTR, containing the detail currency of the detail.

pvTickSysNum

[out] Returns a VARIANT, subtype LONG, containing the system number of the detail that is ticked by this detail.

Return value

True if the detail with the given index exists, otherwise false.

See Also

	CreateSndry
	Handling accounting documents using the SDK
	GetDetail2
	PrepareDocument
	GetNumDetails
	CancelDocument

Samples

C++

// Retrieve all detail data of the current document
VARIANT vAmountDocC, vQuantity, vValue1, vAccount, vRemark, vText1, vAmountDetC, vDetC, vTickSysNum;
short sNumDetails;

pSndry->PrepareDocument (paView);

sNumDetails = pSndry->GetNumDetails ();

for (short sDetail = 0; sDetail < sNumDetails; sDetail++)
{
    if (pSndry->GetDetail (sDetail, &vAmountDocC, &vQuantity, &vValue1, &vAccount, &vRemark, &vText1, &vAmountDetC, &vDetC, &vTickSysNum))
    {
        // Process data
    }
}

pSndry->CancelDocument ();

// Retrieve all detail data of the current document
object oAmountDocC, oQuantity, oValue1, oAccount, oRemark, oText1, oAmountDetC, oDetC, oTickSysNum;
short sNumDetails;

oSndry.PrepareDocument (ePrepareAction.paView);

sNumDetails = oSndry.GetNumDetails ();

for (short sDetail = 0; sDetail < sNumDetails; sDetail++)
{
    if (oSndry.GetDetail (sDetail, out oAmountDocC, out oQuantity, out oValue1, out oAccount, out oRemark, out oText1, out oAmountDetC, out oDetC, out oTickSysNum))
    {
        // Process data
    }
}

oSndry.CancelDocument ();

VBS

' Retrieve all detail data of the current document
Dim oAmountDocC, oQuantity, oValue1, oAccount, oRemark, oText1, oAmountDetC, oDetC, oTickSysNum
Dim sDetail, sNumDetails

Call oSndry.PrepareDocument(paView)

sNumDetails = oSndry.GetNumDetails()

For sDetail = 0 To sNumDetails - 1
    If oSndry.GetDetail(sDetail, oAmountDocC, oQuantity, oValue1, oAccount, oRemark, oText1, oAmountDetC, oDetC, oTickSysNum) Then
        ' Process data
    End If
Next

Call oSndry.CancelDocument()

VB.NET

' Retrieve all detail data of the current document
Dim oAmountDocC, oQuantity, oValue1, oAccount, oRemark, oText1, oAmountDetC, oDetC, oTickSysNum As Object
Dim sNumDetails As Short

oSndry.PrepareDocument(ePrepareAction.paView)

sNumDetails = oSndry.GetNumDetails()

For sDetail As Short = 0 To sNumDetails - 1
    If oSndry.GetDetail(sDetail, oAmountDocC, oQuantity, oValue1, oAccount, oRemark, oText1, oAmountDetC, oDetC, oTickSysNum) Then
        ' Process data
    End If
Next

Call oSndry.CancelDocument()