DocumentAuthor, DocumentCreator, DocumentSubject and DocumentKeywords

The DocumentAuthor, DocumentCreator, DocumentSubject and DocumentKeywords properties are used to set the metadata associated with a document.

 

Syntax

ActiveX:

System.String DocumentAuthor
System.String DocumentCreator
System.String DocumentSubject
System.String DocumentKeywords

DLL:

long SetAuthor(HANDLE hIntf, LPCSTR szValue)
long SetCreator(HANDLE hIntf, LPCSTR szValue)
long SetSubject(HANDLE hIntf, LPCSTR szValue)
long SetKeywords(HANDLE hIntf, LPCSTR szValue)

 

Parameters

DocumentAuthor, DocumentCreator, DocumentSubject, DocumentKeywords

[in, out] The various document metadata to be stored in the output PDF, can be either Ansi or Unicode.

hIntf

Handle to printer returned by any of the DriverInit function calls.

szValue

[out] An ansi or Unicode string containing the attribute value.

 

Return Value

SetAuthor, SetCreator, SetSubject and SetKeywords return 1 if successful, 0 otherwise.  DocumentAuthor, DocumentCreator, DocumentSubject and DocumentKeywords return the current value for each property.

 

Remarks

These functions can be used in two situations:

  1. The developer needs to modify the default values for the printer; in this case SetDefaultConfig should be called after modifying these settings to set the value as default for all applications. Application developers should not call this function for every printout but only after printer initialization.

  2. The printer device context is created using the function CDICreateDC. This function uses the settings provided by these functions and there is no need to call SetDefaultConfig.

 

Member of CDIntfEx.CDIntfEx.

 

Example

<Flags()>


Public Enum acFileNameOptions As Integer


    ' Please check FileNameOptions for the complete flags version


    NoPrompt = &H1


    UseFileName = &H2


    Concatenate = &H4


    DisableCompression = &H8


    EmbedFonts = &H10


    BroadcastMessages = &H20


    PrintWatermark = &H40


End Enum


 


Public Sub Sample()


    ' Constants for Activation codes


    Const strLicenseTo As String = "Amyuni PDF Converter Evaluation"


    Const strActivationCode As String = "07EFCDAB0100010025AFF1801CB9441306C5739F7D452154D8833B9CECBA2ADE79E3762A69FFC354528A5F4A5811BE3204A0A439F5BA"


    Const AMYUNIPRINTERNAME As String = "Amyuni PDF Converter"


 


    ' Declare a new cdintfex object if it does not exist in the form.


    Dim PDF As New CDIntfEx.CDIntfEx


 


    ' Get a reference to the installed printer.


    ' This will fail if the printer name passed to the DriverInit method is 


    ' not found in the printer’s folder


    PDF.DriverInit(AMYUNIPRINTERNAME)


 


    ' The SetDefaultPrinter function sets the system default printer to the one


    ' initialized by the DriverInit functions.


    PDF.SetDefaultPrinter()


 


    ' The EnablePrinter() method needs to be called right before each print job.


    ' and before the configuration


    ' Calling the EnablePrinter() method will start a 20 second time-out value


    PDF.EnablePrinter(strLicenseTo, strActivationCode)


 


    ' Resulting PDF document stored here


    PDF.DefaultDirectory = "C:\Temp"


 


    ' Set Printer options


    PDF.FileNameOptionsEx = acFileNameOptions.NoPrompt


 


    ' Set Document Author


    PDF.DocumentAuthor = "Amyuni"


 


    ' Set Document Creator


    PDF.DocumentCreator = "Amyuni Technologies"


 


    ' Set Document Subject


    PDF.DocumentSubject = "Sample Code"


 


    ' Set Document Keywords


    PDF.DocumentKeywords = "Amyuni, Sample, Code"


 


    ' Set the Values


    PDF.SetDefaultConfig()


 


    ' The BatchConvert method converts a number of files to PDF.


    PDF.BatchConvert("C:\Temp\*.docx")


 


    ' The RestoreDefaultPrinter function resets the system default printer 


    ' to the printer that was the default before the call to SetDefaultPrinter.


    PDF.RestoreDefaultPrinter()


 


    ' This function will simply detach from an existing printer because the handle was created using DriverInit


    PDF.DriverEnd()


 


    ' Destroy PDF object


    PDF = Nothing    


End Sub


[Flags]


public enum acFileNameOptions


{


    // Please check FileNameOptions for the complete flags version


    NoPrompt = 0x00000001,


    UseFileName = 0x00000002,


    Concatenate = 0x00000004,


    DisableCompression = 0x00000008,


    EmbedFonts = 0x00000010,


    BroadcastMessages = 0x00000020,


    PrintWatermark = 0x00000040


}


public void Sample()


{


    // Constants for Activation codes


    const string strLicenseTo = "Amyuni PDF Converter Evaluation";


    const string strActivationCode = "07EFCDAB0100010025AFF1801CB9441306C5739F7D452154D8833B9CECBA2ADE79E3762A69FFC354528A5F4A5811BE3204A0A439F5BA";


    const string AMYUNIPRINTERNAME = "Amyuni PDF Converter";


 


    // Declare a new cdintfex object if it does not exist in the form.


    CDIntfEx.CDIntfEx PDF = new CDIntfEx.CDIntfEx();


 


    // Get a reference to the installed printer.


    // This will fail if the printer name passed to the DriverInit method is 


    // not found in the printer’s folder


    PDF.DriverInit(AMYUNIPRINTERNAME);


 


    // The SetDefaultPrinter function sets the system default printer to the one


    // initialized by the DriverInit functions.


    PDF.SetDefaultPrinter();


 


    // The EnablePrinter() method needs to be called right before each print job.


    // and before the configuration


    // Calling the EnablePrinter() method will start a 20 second time-out value


    PDF.EnablePrinter(strLicenseTo, strActivationCode);


 


    // Resulting PDF document stored here


    PDF.DefaultDirectory = @"C:\Temp";


 


    // Set Printer options


    PDF.FileNameOptionsEx = (int)acFileNameOptions.NoPrompt;


 


    // Set Document Author


    PDF.DocumentAuthor = "Amyuni";


 


    // Set Document Creator


    PDF.DocumentCreator = "Amyuni Technologies";


 


    // Set Document Subject


    PDF.DocumentSubject = "Sample Code";


 


    // Set Document Keywords


    PDF.DocumentKeywords = "Amyuni, Sample, Code";


 


    // Set the Values


    PDF.SetDefaultConfig();


 


    // The BatchConvert method converts a number of files to PDF.


    PDF.BatchConvert(@"c:\\Temp\\*.docx");


 


    // The RestoreDefaultPrinter function resets the system default printer 


    // to the printer that was the default before the call to SetDefaultPrinter.


    PDF.RestoreDefaultPrinter();


 


    // This function will simply detach from an existing printer because the handle was created using DriverInit


    PDF.DriverEnd();


 


 


}


// PDF Converter Cpp.cpp : Defines the entry point for the console application.


// 


 


#include <Windows.h>


#include <string>


#include <iostream>


#include "CdIntf.h"


#pragma comment (lib, "CDIntf.lib")


 


using namespace std;


int main()


{


    // Constants for Activation codes


    #define strLicenseTo  "Amyuni PDF Converter Evaluation"


    #define strActivationCode "07EFCDAB0100010025AFF1801CB9441306C5739F7D452154D8833B9CECBA2ADE79E3762A69FFC354528A5F4A5811BE3204A0A439F5BA"


    #define AMYUNIPRINTERNAME "Amyuni PDF Converter"


 


    // Get a reference to the installed printer.


    // This will fail if the printer name passed to the DriverInit method is 


    // not found in the printer’s folder


    HANDLE PDF = DriverInit(AMYUNIPRINTERNAME);


 


    // The CDISetDefaultPrinter function sets the system default printer to the one


    // initialized by the DriverInit functions.


    CDISetDefaultPrinter(PDF);


 


    // The EnablePrinter() method needs to be called right before each print job.


    // and before the configuration


    // Calling the EnablePrinter() method will start a 20 second time-out value


    EnablePrinter(PDF, strLicenseTo, strActivationCode);


 


    // Resulting PDF document stored here


    SetDefaultDirectory(PDF, "c:\\Temp");


 


    // Set Printer options


    SetFileNameOptions(PDF, NoPrompt);


 


    // Set Document Author


    SetAuthor(PDF, "Amyuni");


 


    // Set Document Creator


    SetCreator(PDF, "Amyuni Technologies");


 


    // Set Document Subject


    SetSubject(PDF, "Sample Code");


 


    // Set Document Keywords


    SetKeywords(PDF, "Amyuni, Sample, Code");


 


    // Set the Values


    SetDefaultConfig(PDF);


 


    // The BatchConvert method converts a number of files to PDF.


    BatchConvertEx(PDF, "c:\\Temp\\*.docx");


 


    // The RestoreDefaultPrinter function resets the system default printer 


    // to the printer that was the default before the call to SetDefaultPrinter.


    RestoreDefaultPrinter(PDF);


 


    // This function will simply detach from an existing printer because the handle was created using DriverInit


    DriverEnd(PDF);    


 


    // Destroy PDF object


    PDF = nullptr;    


 


    return 0;


}


package Example;


 


import com.jacob.activeX.ActiveXComponent;


import com.jacob.com.Dispatch;


 


public class Sample {


    public enum acFileNameOptions


    {


        // Please check FileNameOptions for the complete flags version


        NoPrompt(0x00000001),


        UseFileName(0x00000002),


        Concatenate(0x00000004),


        DisableCompression(0x00000008),


        EmbedFonts(0x00000010),


        BroadcastMessages(0x00000020),


        PrintWatermark(0x00000040);


        public int value;


        public acFileNameOptions(int value)


        {


            this.value = value;


        }


        public Object value(){


            return value;


        }


    }


    public static void main(String[] args)


    {


        // Constants for Activation codes


        String strLicenseTo  = "Amyuni PDF Converter Evaluation";


        String strActivationCode = "07EFCDAB0100010025AFF1801CB9441306C5739F7D452154D8833B9CECBA2ADE79E3762A69FFC354528A5F4A5811BE3204A0A439F5BA";


        String AMYUNIPRINTERNAME = "Amyuni PDF Converter";


 


        // Declare a new cdintfex object if it does not exist in the form.


        ActiveXComponent pdf = new ActiveXComponent("CDIntfEx.CDIntfEx.6.5"); 


 


        // Get a reference to the installed printer.


        // This will fail if the printer name passed to the DriverInit method is 


        // not found in the printer’s folder


        Dispatch.call(pdf,"DriverInit",AMYUNIPRINTERNAME);


 


        // The SetDefaultPrinter function sets the system default printer to the one


        // initialized by the DriverInit functions.


        Dispatch.call(pdf,"SetDefaultPrinter");


 


        // The EnablePrinter() method needs to be called right before each print job.


        // and before the configuration


        // Calling the EnablePrinter() method will start a 20 second time-out value


        Dispatch.call(pdf,"EnablePrinter", strLicenseTo, strActivationCode);


 


        // Resulting PDF document stored here


        Dispatch.put(pdf,"DefaultDirectory","c:\\Temp");


 


        // Set Printer options


        Dispatch.put(pdf,"FileNameOptionsEx",acFileNameOptions.NoPrompt.value);


 


        // Set Document Author


        Dispatch.put(pdf,"DocumentAuthor", "Amyuni");


 


        // Set Document Creator


        Dispatch.put(pdf,"DocumentCreator", "Amyuni Technologies");


 


        // Resulting PDF document stored here


        Dispatch.put(pdf,"DocumentAuthor", "Amyuni");


 


        // Set Document Subject


        Dispatch.put(pdf,"DocumentSubject", "Sample Code");


 


        // Set Document Keywords


        Dispatch.put(pdf,"DocumentKeywords", "Amyuni, Sample, Code");


 


        // Set the Values


        Dispatch.call(pdf,"SetDefaultConfig");


 


        // The BatchConvert method converts a number of files to PDF.


        Dispatch.call(pdf,"BatchConvert","c:\\temp\\*.docx");


 


        // The RestoreDefaultPrinter function resets the system default printer 


        // to the printer that was the default before the call to SetDefaultPrinter.


        Dispatch.call(pdf,"RestoreDefaultPrinter"); 


 


        // This function will simply detach from an existing printer because the handle was created using DriverInit


        Dispatch.call(pdf,"DriverEnd");


 


        // Destroy PDF object


        pdf = null;        


    }


}


$acFileNameOptions = @{


    NoPrompt = 0x00000001


    UseFileName = 0x00000002


    Concatenate = 0x00000004


    DisableCompression = 0x00000008


    EmbedFonts = 0x00000010


    BroadcastMessages = 0x00000020


    PrintWatermark = 0x00000040


} 


#Please check FileNameOptions for the complete flags version


 


# Constants for Activation codes


$strLicenseTo  =  "Amyuni PDF Converter Evaluation"


$strActivationCode = "07EFCDAB0100010025AFF1801CB9441306C5739F7D452154D8833B9CECBA2ADE79E3762A69FFC354528A5F4A5811BE3204A0A439F5BA"


$AMYUNIPRINTERNAME = "Amyuni PDF Converter"


 


#Declare a new cdintfex object if it does not exist in the form.


$PDF = New-Object -ComObject CDIntfEx.CDIntfEx.6.5


 


#Get a reference to the installed printer.


#This will fail if the printer name passed to the DriverInit method is 


#not found in the printer’s folder


[System.__ComObject].InvokeMember('DriverInit', [System.Reflection.BindingFlags]::InvokeMethod,$null,$PDF,$AMYUNIPRINTERNAME) 


 


#The SetDefaultPrinter function sets the system default printer to the one


#initialized by the DriverInit functions.


[System.__ComObject].InvokeMember('SetDefaultPrinter', [System.Reflection.BindingFlags]::InvokeMethod,$null,$PDF,$null) 


 


#The EnablePrinter() method needs to be called right before each print job.


#and before the configuration


#Calling the EnablePrinter() method will start a 20 second time-out value


[System.__ComObject].InvokeMember('EnablePrinter', [System.Reflection.BindingFlags]::InvokeMethod,$null,$PDF, @($strLicenseTo, $strActivationCode))


 


#Resulting PDF document stored here


[System.__ComObject].InvokeMember('DefaultDirectory', [System.Reflection.BindingFlags]::SetProperty,$null,$PDF,"C:\Temp") 


 


#Set Printer options


[System.__ComObject].InvokeMember('FileNameOptionsEx', [System.Reflection.BindingFlags]::SetProperty,$null,$PDF,$acFileNameOptions::NoPrompt)


 


#Set Document Author


[System.__ComObject].InvokeMember('DocumentAuthor', [System.Reflection.BindingFlags]::SetProperty,$null,$PDF,"Amyuni") 


 


#Set Document Creator


[System.__ComObject].InvokeMember('DocumentCreator', [System.Reflection.BindingFlags]::SetProperty,$null,$PDF,"Amyuni Technologies")


 


#Set DocumentSubject


[System.__ComObject].InvokeMember('DocumentSubject', [System.Reflection.BindingFlags]::SetProperty,$null,$PDF,"Sample Code")


 


#Set Document Keywords


[System.__ComObject].InvokeMember('DocumentKeywords', [System.Reflection.BindingFlags]::SetProperty,$null,$PDF,"Amyuni, Sample, Code") 


 


#Set the Values


[System.__ComObject].InvokeMember('SetDefaultConfig', [System.Reflection.BindingFlags]::SetProperty,$null,$PDF,$null) 


 


#The BatchConvert method converts a number of files to PDF.


[System.__ComObject].InvokeMember('BatchConvert', [System.Reflection.BindingFlags]::InvokeMethod,$null,$PDF, "C:\temp\*.docx")


 


#The RestoreDefaultPrinter function resets the system default printer 


#to the printer that was the default before the call to SetDefaultPrinter.


[System.__ComObject].InvokeMember('RestoreDefaultPrinter', [System.Reflection.BindingFlags]::InvokeMethod,$null,$PDF,$null) 


 


#This function will simply detach from an existing printer because the handle was created using DriverInit 


[System.__ComObject].InvokeMember('DriverEnd', [System.Reflection.BindingFlags]::InvokeMethod,$null,$PDF,$null) 


 


#Destroy PDF object


$PDF = $null


' FileNameOptions constants


' Please check FileNameOptions for the complete flags version


Const NoPrompt = &H1


Const UseFileName = &H2


Const Concatenate = &H4


Const DisableCompression = &H8


Const EmbedFonts = &H10


Const BroadcastMessages = &H20


Const PrintWatermark = &H40


Const MultilingualSupport = &H80


Const EncryptDocument = &H100


Const FullEmbed = &H200


 


' Constants for Activation codes


Const strLicenseTo = "Amyuni PDF Converter Evaluation"


Const strActivationCode = "07EFCDAB0100010025AFF1801CB9441306C5739F7D452154D8833B9CECBA2ADE79E3762A69FFC354528A5F4A5811BE3204A0A439F5BA"


Const AMYUNIPRINTERNAME = "Amyuni PDF Converter"


 


' Declare a new cdintfex object


Dim PDF


Set PDF = CreateObject("CDIntfEx.CDIntfEx.6.5")


 


' Get a reference to the installed printer.


' This will fail if the printer name passed to the DriverInit method is


' not found in the printer’s folder


PDF.DriverInit AMYUNIPRINTERNAME


 


' The SetDefaultPrinter function sets the system default printer to the one


' initialized by the DriverInit functions.


PDF.SetDefaultPrinter


 


' The EnablePrinter() method needs to be called right before each print job.


' and before the configuration


' Calling the EnablePrinter() method will start a 20 second time-out value


PDF.EnablePrinter strLicenseTo, strActivationCode


 


' Resulting PDF document stored here


PDF.DefaultDirectory = "C:\Temp"


 


' Set Printer options


PDF.FileNameOptionsEx = NoPrompt


 


' Set Document Author


PDF.DocumentAuthor = "Amyuni"


 


' Set Document Creator


PDF.DocumentCreator = "Amyuni Technologies"


 


' Set Document Subject


PDF.DocumentSubject = "Sample Code"


 


' Set Document Keywords


PDF.DocumentKeywords = "Amyuni, Sample, Code"


 


' Set the Values


PDF.SetDefaultConfig


 


' The BatchConvert method converts a number of files to PDF.


PDF.BatchConvert "C:\Temp\*.docx"


 


' The RestoreDefaultPrinter function resets the system default printer


' to the printer that was the default before the call to SetDefaultPrinter.


PDF.RestoreDefaultPrinter


 


' This function will simply detach from an existing printer because the handle was created using DriverInit


PDF.DriverEnd


 


' Destroy PDF object


Set PDF = Nothing