NWDPObjectIdentification

Contains a union of all of the different object identifications supported


Structure

typedef struct {  
   NWDPObjectIdentificationEnum designator;  
   union {  
      NWDPPrtContainedObjectId     prtContainedObjectId;  
      NWDPDocumentIdentifier       documentIdentifier;  
      NWDPObjectIdentifier          objectIdentifier;  
      NWDPDistinguishedNameString   objectName;  
      NWDPNameOrOid             nameOrOid;  
      NWDPText                   simpleName;  
      NWDPPrtConfigObjectId         prtConfigObjectId;  
      NWDPQualifiedName           qualifiedName;  
      NWDPEventObjectId            eventObjectId;  
   } u;  
} NWDPObjectIdentification, N_FAR *pNWDPObjectIdentification;


Header File

nwdp_att.h


Fields

designator

Specifies the type of object ID:

0 NWDP_OBJ_ID_NONE
1 NWDP_OBJ_ID_PRT_CONTAIND_OBJ_ID
2 NWDP_OBJ_ID_DOCUMENT_IDENTIFIER
3 NWDP_OBJ_ID_OBJECT_IDENTIFIER
4 NWDP_OBJ_ID_OBJECT_NAME
5 NWDP_OBJ_ID_NAME_OR_OID
6 NWDP_OBJ_ID_SIMPLE_NAME
7 NWDP_OBJ_ID_PRT_CONFIG_OBJ_ID
8 NWDP_OBJ_ID_QUALIFIED_NAME
9 NWDP_OBJ_ID_EVENT_OBJECT_ID

prtContainedObjectId

Specifies an object contained by a logical printer.


documentIdentifier

Specifies a document.


objectIdentifier

Specifies an object.


objectName

Specifies the name of the object.


nameOrOid

Specifies an identifier that might have either a global or local form (see ISO10175-1: section 9.1.5.38).


simpleName

Specifies a short human-readable string representation of a simple name for an object created by an administrator (see ISO10175-1: section 9.1.5.6).


prtConfigObjectId

Specifies a printer configuration object that describes defaults and limits.


qualifiedName

Specifies an object's name, either as a simple name (Unicode zero-terminated string) or as a fully canonicalized NDSTM name with corresponding NDS Tree name.


eventObjectId

Specifies the identification of an NDPSTM event. This includes the event type, the name of the event, and the OID of the Containing Class.


Remarks

There is a one-to-one correspondence between the designator values and the fields within the union. Each of these fields specifies the kind of object mentioned in the naming. Grouping these fields together allows list object attributes (LOA) operations to be performed on any object of these types without increasing the complexity of the interface elsewhere.

NWDPObjectIdentification corresponds to ISO 10175-1, section 8.2.4.1.

NWDPObjectIdentification can also be used to store a reference to an object in an object attribute, using the NWDP_AVT_OBJECT_IDENTIFICATION syntax. See Object Instance for more information.