Xceed Logo
Shop
Xceed Zip for COM/ActiveX on x86/x64 Documentation
Direct DLL API / DLL API function reference / XziGetFirstItem function
In This Topic
    XziGetFirstItem function
    In This Topic

    Description

    Calling this function will provide you with the first item in an XceedZipItems collection. The item is provided to you in the form of an xcdListingFileParams structure. This structure contains the same information as an XceedZipItem object provides to applications not using the DLL API.

    To use the method, you must provide a handle to an XceedZipItems collection. The handle is obtained by calling the XzGetZipContents method. That method's second parameter (phItems) receives a handle to an XceedZipItems collection.

    To get the second and subsequent items, call the XziGetNextItem function.

    Declaration  
    BOOL XziGetFirstItem( HXCEEDZIPITEMS hItems, xcdListingFileParams* pxItem );

    Parameters

    Parameter Description
    hItems  Handle of the XceedZipItems collection in which to get the first item
    pxItem  Pointer to an xcdListingFileParams structure to fill with the information of the first file

    Return value

    Returns True if successful (there was at least one item in the collection).

     

     

    © Xceed Software Inc. All Rights Reserved.

    Send comments on this topic.