Share via

LoadIconForPDF Method in Class SMS_PDF_Package

  • Article

The LoadIconForPDF WMI class method imports a required icon for a PDF. PDF files can reference icons to be used with the package. These icons are not part of the file and need to be loaded separately.

The following syntax is simplified from MOF code and is intended to show you the definition of the method.

sint32 LoadIconForPDF(
  [in] uint32 PDFID,
  [in, SizeLimit("100")] string IconFileName,
  [in] uint8 Icon[]
);

Parameters

  • PDFID
    Data type: uint32
    Qualifiers: In

    Identifier of the PDF to which you are adding icons. Get this value from the PDFID out parameter of the LoadPDF method.

  • IconFileName
    Data type: string
    Qualifiers: In

    Full path and file name of a required PDF icon. Get the icon name from the RequriedIconNames output parameter of the LoadPDF method. Include the path if necessary.

  • Icon
    Data type: uint8[]
    Qualifiers: In

    Icon to associate with the package.

Return Values

The LoadIconForPDF method returns a sint32 that is always zero (0).

Example Code

For an example that uses the LoadIconForPDF method, see LoadPDF.

Remarks

You must call LoadIconForPDF for every icon that LoadPDF returns.

See Also

LoadPDF, SMS_PDF_Package