wpQueryRemoteOptions
This method is specific to version 3, or higher, of the OS/2 operating system.
This instance method returns the printer object's remote options.
Syntax
_wpQueryRemoteOptions(somSelf, pulRefreshInterval,
pflAllJobs)
Parameters
- somSelf (WPPrinter *) - input
- Pointer to the object on which the method is being invoked.
- Points to an object of class WPPrinter.
- pulRefreshInterval (PULONG) - output
- Pointer to the time interval indicating when the printer object is refreshed.
- The time interval is expressed in seconds.
- pflAllJobs (PULONG) - output
- Pointer to the flag indicating which jobs to display.
- TRUE Display all jobs waiting in the network queue.
- FALSE Display only the current user's jobs waiting in the network queue.
Returns
- rc (BOOL) - returns
- Success indicator.
- TRUE Successful completion.
- FALSE Error occurred.
How to Override
This method is generally not overridden.
Usage
This method can be called at any time.
Remarks
This method is not covered in the provided text.
Example Code
#define INCL_WINWORKPLACE
#include <os2.h>
WPPrinter *somSelf; /* Pointer to the object on which the method is being invoked. */
PULONG pulRefreshInterval; /* Pointer to the time interval indicating when the printer object is refreshed. */
PULONG pflAllJobs; /* Pointer to the flag indicating which jobs to display. */
BOOL rc; /* Success indicator. */
rc = _wpQueryRemoteOptions(somSelf, pulRefreshInterval,
pflAllJobs);
/* Example code provided in the source: */
BOOL rc;
ULONG ulOrigRefreshSeconds = 0;
ULONG ulOrigAllJobsDisplay = 0;
ULONG ulRefreshSeconds = 5; /* Refresh interval of 5 seconds */
ULONG ulAllJobsDisplay = TRUE; /* Display all jobs */
rc = _wpQueryRemoteOptions( somSelf
, &ulOrigRefreshSeconds
, &ulOrigAllJobsDisplay);
somPrintf("Original Refresh = %u, Jobs Display = %u.\n",
ulOrigRefreshSeconds,ulOrigAllJobsDisplay);
rc = _wpSetRemoteOptions( somSelf
, ulRefreshSeconds
, ulAllJobsDisplay);