`Pro.Lnk` — API for parsing Windows Link files¶

Overview¶

The Pro.Lnk module contains the API for parsing Windows Link files.

Printing the Contents of a Link¶

The following code example demonstrates how to output the contents of a link file:

from Pro.Core import *
from Pro.Lnk import *

def parseLink(fname):
    c = createContainerFromFile(fname)
    if c.isNull():
        return
    obj = LnkObject()
    if not obj.Load(c) or not obj.Initialize():
        return
    out = proTextStream()
    obj.Dump(out)
    print(out.buffer)

Module API¶

Pro.Lnk module API.

Classes:

LnkObject()

This class represents a Windows link file.

class LnkObject¶

Bases: Pro.Core.CFFObject

This class represents a Windows link file.

See also Dump() and GetTarget().

Methods:

Dump(out)

Dumps the contents of the link to the specifed text stream.

DumpExtraData(out)

Dumps the extra data to the specifed text stream.

DumpFileHeader(out)

Dumps the file header to the specifed text stream.

DumpLinkInfo(out)

Dumps the link information to the specifed text stream.

DumpLinkTargetIDList(out)

Dumps the target ID list to the specifed text stream.

DumpStringData(out)

Dumps the string data to the specifed text stream.

GetTarget()

Returns the target of the link.

HasExtraData()

Returns True if extra data is present; otherwise returns False.

HasLinkInfo()

Returns True if link information is present; otherwise returns False.

HasLinkTargetIDList()

Returns True if a target ID list is present; otherwise returns False.

HasStringData()

Returns True if string data is present; otherwise returns False.

Dump(out: Pro.Core.NTTextStream) → None¶

Dumps the contents of the link to the specifed text stream.

Parameters

out (NTTextStream) – The output text stream.

DumpExtraData(out: Pro.Core.NTTextStream) → None¶

Dumps the extra data to the specifed text stream.

Parameters

out (NTTextStream) – The output text stream.

See also HasExtraData().

DumpFileHeader(out: Pro.Core.NTTextStream) → None¶

Dumps the file header to the specifed text stream.

Parameters

out (NTTextStream) – The output text stream.

DumpLinkInfo(out: Pro.Core.NTTextStream) → None¶

Dumps the link information to the specifed text stream.

Parameters

out (NTTextStream) – The output text stream.

See also HasLinkInfo().

DumpLinkTargetIDList(out: Pro.Core.NTTextStream) → None¶

Dumps the target ID list to the specifed text stream.

Parameters

out (NTTextStream) – The output text stream.

See also HasLinkTargetIDList().

DumpStringData(out: Pro.Core.NTTextStream) → None¶

Dumps the string data to the specifed text stream.

Parameters

out (NTTextStream) – The output text stream.

See also HasStringData().

GetTarget() → str¶

Returns

Returns the target of the link.

Return type

str

HasExtraData() → bool¶

Returns

Returns True if extra data is present; otherwise returns False.

Return type

bool

See also DumpExtraData().

HasLinkInfo() → bool¶

Returns

Returns True if link information is present; otherwise returns False.

Return type

bool

See also DumpLinkInfo().

HasLinkTargetIDList() → bool¶

Returns

Returns True if a target ID list is present; otherwise returns False.

Return type

bool

See also DumpLinkTargetIDList().

HasStringData() → bool¶

Returns

Returns True if string data is present; otherwise returns False.

Return type

bool

See also DumpStringData().