Navigation:  Appendices > Appendix J: Job Status/Actions/API > Job Admin DLL Function List > Admin Functions

Function Name: AreaCode

Extract USA Area Code from dialled number

Inputs:  Parm1 = Dialled number

Outputs: Parm2 = name of area

Returns: Area Code number, or 0 if not identified

 

Function Name: CountryCode

Extract Country Code from dialled number

Inputs:  Parm1 = Dialled number

Outputs: Parm2 = name of country

Returns: Country Code number, or 0 if not identified

 

Function Name: DLLClose

This function should be called before termination by any application which directly or indirectly uses MSMQ operations

Inputs:  none

Outputs: none

Returns: 0

 

Function Name: GetCopiaShare

Get the pathname of the Copia Application Data folder.

Inputs:  none

Outputs: Parm1 = pathname of base FAXFACTS folder

Returns:  0 = success
         -1 = cannot determine folder

Note that Copia applications will not receive a -1 return code because the DLL will not be called if the configuration is invalid.

 

Function Name: GetDate

Get date the date value for use in setting system variable JOB_SCHEDULED from $fax_send_date and/or $fax_send_time in the job template properties; or for setting JOB_TIMESTAMP from the time of the last status change (.JST file).

Inputs:  Parm1 = Job Instance UJP pathname
         Parm3 = scheduled date (0), status date (1)

Outputs: Parm2 = YYYYMMDDHHNNSS

Returns:  0 = success
         -1 = job instance not found

 

Function Name: GetDigits

Inputs:  none

Returns: number of digits in job names (default 5)

 

Function Name: GetInstancePath

Builds a full pathname from Owner, Job Type, and instance number

Inputs:  Parm1 = owner
         Parm2 = jobtype
         Parm3 = job instance number

Outputs: Parm1 = path to instance UJP

Returns:  0 = instance found 
         -1 = owner not found
         -2 = jobtype not found
         -3 = instance not found
         -4 = resulting path >256 bytes

 

Function Name: GetJobtypeInst

Searches for a job instance number anywhere under a specific jobtype.

Inputs:  Parm1 = Path to jobtype UJP
         Parm3 = Instance number

Outputs: Parm1 = full path to instance UJP

Returns: Instance number or <0 if error
         -1 = No instance found with passed number
         -3 = Passed JobType.UJP not found

 

Function Name: GetOwnerInst

Searches for a job instance number anywhere under a specific owner.

Inputs:  Parm1 = Path to owner UJP
         Parm3 = Instance number

Outputs: Parm1 = full path to instance UJP

Returns: Instance number or <0 if error
         -1 = No instance found with passed number
         -2 = Instance numbering not owner-based nor system
         -3 = Passed Owner.UJP not found

 

Function Name: GetStartFS

Gets the starting FS number for an already-launched job.

Inputs:  Parm1 = Instance UJP name

Returns: Starting FS number of job
          0 = job not launched
         -1 = no such instance

 

Function Name: GetSystemInst

Searches for a job instance number anywhere in the system (numbering must set as system-wide).

Inputs:  Parm3 = Instance number

Outputs: Parm1 = full path to instance UJP

Returns: Instance number or <0 if error
         -1 = No instance found with passed number
         -2 = Instance numbering is not system-wide

 

AddQuotes

Applies double-quotes to the specified string

Inputs:  Parm1 = Input string

Outputs: Parm2 = Quoted string

Example:

strcopy(parm1, "C:\\Program Files\\Copia");

(void)JobDllEntry("AddQuotes", parm1, parm2, 0);

// output in parm2 : "C:\Program Files\Copia"

 

StripQuotes

Strip double-quotes from the specified string

Inputs:  Parm1 = Input string

Outputs: Parm2 = Quotes-stripped string

Example:

strcopy(parm1, "\"This is a \"\"test\"\"\");

(void)JobDllEntry("StripQuotes", parm1, parm2, 0);

// output in parm2 : This is a "test"

 

ExpandFolderVariables

Expand any standard CopiaFacts folder variables

Inputs:  Parm1 = Input string

Outputs: Parm2 = Expanded string

Example:

strcopy(parm1, "@FFBASE\FAXFACTS.CFG");

(void)JobDllEntry("ExpandFolderVariables", parm1, parm2, 0);

// output in parm2 : \\MNAME\COPIA\FAXFACTS\FAXFACTS.CFG

 

EmbedFolderVariable

Embed a standard CopiaFacts folder variable

Inputs:  Parm1 = Input string
         Parm2 = Folder variable to use

Outputs: Parm2 = String including applicable variable

Example:

strcopy(parm1, "\\MNAME\COPIA\FAXFACTS\USERJOBS\SYSTEM.UJP");

strcopy(parm2, "@FFJOBS");

(void)JobDllEntry("EmbedFolderVariable", parm1, parm2, 0);

// output in parm2 : @FFJOBS\SYSTEM.UJP

 

---

Topic url: http://www.copia.com/support/refmanual/index.html?admin_functions.htm